ALTAIR Breeze Graphical User Interface Installation Guide
- June 4, 2024
- ALTAIR
Table of Contents
- Required Items
- Evaluation
- Altair License Manager (ALM)
- Legacy Ellexus Node-locked license installation
- Legacy Ellexus Floating license installation
- Installing the legacy Ellexus license server (floating license only)
- Installing Breeze Automation Platform
- License for Breeze Automation Platform or Breeze Healthcheck
- Adding A New License (legacy floating license users)
- References
- Read User Manual Online (PDF format)
- Download This Manual (PDF format)
Altair – Breeze Installation Guide
Version 2.14.2
Installation Guide
Required Items
The following items should be found on any standard Linux installation. The Breeze GUI will detect them on start-up and warn you if it detects a potential problem.
- You will need to have GDK+ 2.2 installed. We recommend at least GTK+ 2.8 This is part of the minimum install with most Linux distributions.
Evaluation
To evaluate Breeze, please contact Altair for an evaluation license.
Altair License Manager (ALM)
3.1 Installing Altair License Manager (ALM)
3.1.1 Introduction
The Altair License Manager (ALM) serves network licenses. It runs on a license
server host that can be reached by network clients. By default, it restarts on
the machine restart. The Altair License Manager (ALM) is built on
X-Formation’s LM-X license manager suite.
3.1.1.1 Components
These are the main components of the license server used by Breeze:
- License server (lmx-serv and liblmxven dor. so)
- Configuration files (plus.conf, Altair-serv.cfg, and optional command-line .cfg file)
- The license file (altair_lic.dat)
- Environment variables ( ALTAIR_LICENSE_PATH, ALUS_CONF_FILE, LICENSE_SERVER_PATH, etc.)
3.1.1.2 Ports
By default, the license server uses TCP/IP port 6200. If you have another
application using that port, the server will not start.
You can edit the Altair-serv.cfg file after installation to change the port
used by the license server.
3.1.1.3 Running Other License Servers with ALM
You can run multiple ALM servers from different vendors on a single machine by
specifying different ports. You can run an older FLEXlm-based version of ALM
(10.0 and prior) alongside the 13.0+ ALM. Be sure to specify different ports
for each license server. You can run an ALM license server side by side with
the license servers of other vendors such as FLEXlm. You can run only one
license server from any specific vendor on a machine at one time. You can run
only one version of LM-X-based Altair
license server on a host.
3.1.1.4 Configuration Files
The license server uses these configuration files:
Illus. conf| Contains Altair-specific configuration information. Required. By
default, located in the current working directory. Location can be specified
using the full path in an ALUS_CONF_FILE environment variable.
---|---
.cfg file| Contains generic ALM configuration data. You can specify this file
on the command line.
Optional.
altair-serv.cfg| Created by the installer. Contains the location of the
license file, the location in which to place the log files, which TCP/IP port
to use, and other configuration information.
3.2 Downloading Altair License Manager (ALM) Package
Altair License Manager (ALM) is available in AltairOne.
3.3 Running the Altair License Manager on Linux
3.3.1 Installing License Manager on Linux
- Log in as root on the license server host.
- You can run the installer via its GUI or on the command line. If you want to use the installer’s GUI, provide an X server and connection. Otherwise, make sure that the environment variable DISPLAY is unset.
- Make sure that port 6200 can be used by the license server and its clients.
- Make sure that the installer is executable, meaning the executable bit is set.
- Run the installer, either via the GUI ( ./
) or the command line ( ./ –i console):
a. If there is an existing license server, the installer asks whether you would like to use the license and configuration files from that installation.
b. Specify the location where you want to install the license server. If you provide a nonexistent directory, the installer creates it.
c. The installer installs the Altair License Manager.
d. The installer asks whether you already have a license file. If you want to use an existing file, give its location.
Otherwise, the installer creates a blank altair_lic.dat file in the installation location; you can replace it later.
e. The installer displays the host ID of the machine.
f. The installer asks whether you want to install the init scripts for an automatic startup; answer yes or no.
g. The installer asks about configuring the usage reporting system and tries to contact the Altair usage reporting server. If you do not have the data to configure the proxy, you can skip this step and manually modify the <install directory>/plus.conf file later. Note that the proxy password is stored in the configuration file in plain text. Be sure to limit access to this file.
3.3.2 Installing License File on Linux
In order to license Breeze, you need a license file supplied by Altair
Engineering, Inc.
-
Provide the host ID of your license server with your request. Log into the license server host and run the following command:
< license server install location > /bin/almutilhostid If you are using one of the ethernet-based host IDs, choose one that is on a permanent interface. Do not use an interface for VPNs or other software-based adapters; these may not always be present. -
When you receive your license file, put it in the
directory. -
By default, the license file is named altair_lic.dat. You can change the name.
-
Make sure that the value of LICENSE_FILE is in the Altair-serv. cf file is the full path to the license file.
-
Restart the license server: altairlmxd restart
3.4 Updating License Manager when Changing License File
When you replace an existing license file with a new one, you must shut down
the license server:
- Log into the license server host
- Replace the existing license file with the new one, or change the value of LICENSE_FILE in the Altair-serv. cf file to the new path.
- Restart the license server: altairlmxd restart
This will not affect running programs. Each client will reconnect to the server once the server is restarted. This may take approximately 15 minutes.
3.5 Configuring Breeze with Altair License Manager (ALM)
You can enter the details for your license by running Breeze – a licensing
window will be shown where you can enter the details.
By default, the license server listens on port 6200 for license requests.
Before running BreezeAP or Breeze Healthcheck on a machine where this has not
yet been done you can set the following environment variable: $ export
ALTAIR_LICENSE_PATH= < port > @ < server >
In versions, prior to v2.14.1, the license was controlled with the
BREEZE_LICENSE environment variable.
Legacy Ellexus Node-locked license installation
- You should have been sent a license file by Ellexus saved as a *.lic.JSON file.
- Start Breeze with $ ./breeze.sh after extracting your download.
- Enter the details for your license file when prompted.
Legacy Ellexus Floating license installation
- In order to use floating licenses, you also need the Lexus license server archive corresponding to your architecture (32-bit or 64-bit). This can be downloaded from our website.
- You should have been sent a license file by Ellexus saved as a *.lic.JSON file.
- Set up the license server using the instructions below.
- Start Breeze with $ ./breeze.sh after extracting your download.
- Enter the details for your license server when prompted.
Installing the legacy Ellexus license server (floating license only)
- Extract the license server archive into your preferred installation directory.
- Place your license in a directory of your choice; since this is a floating license, it only needs to be accessible to the license server and not to Breeze.
- Start the license server on the command line: $ nohup ./ellexus_license_server -d < path to license file/directory > &
By default, the license server will listen on port 5656 for license requests.
A few useful options for the license server are: -d <license file/dir> will
specify a license file to use or a directory to search; by default, this is
the same directory as the server -p
Installing Breeze Automation Platform
Depending on the license you have, install the Breeze Automation Platform
(Breeze AP) using the same instructions above to install a Standard Edition.
The Breeze Automation Platform is a command line application to parse trace
data captured via Breeze or Trace-Only Breeze and export the data as text or
XML files. It can parse data from any of the views shown in Breeze. This
allows automated test suites to be written and allows analysis of the data via
third-party tools. The breezeAP.sh application can be found under the Breeze
installation folder.
License for Breeze Automation Platform or Breeze Healthcheck
Before you can run Breeze Automation Platform or Breeze Healthcheck you must have a license and the ALTAIR_LICENSE_PATH environment variable must be set to the location of the license server. This can be either:
- The IP address and port of the license server are expressed as
@ . The port number used by the license server is usually 6200. - The full path of a directory containing a node-locked license file.
For example:
$ export ALTAIR_LICENSE_PATH=6200@10.33.0.1
If you do not have a license, please contact Altair at
breeze_mistral_support@altair.com
Adding A New License (legacy floating license users)
If you receive a new license (for example, your evaluation period has ended and you have purchased a full license) then you will need to make the license server re-read its license files to become aware of the new license. By default, the server will re-read at midnight every day, but you can also force a re-read manually, in one of three ways:
- Shutdown and restart the license server
Altair – Breeze Installation Guide
References
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>