Licensing Portal User's Guide

ANSYS, Inc. Release Release 2022 R1

Southpointe January 2022
2600 Ansys Drive 000409
Canonsburg, PA 15317 ANSYS, Inc. and
ansysinfo@ansys.com ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2015
(F) 724-514-9494 companies.
Revision Information

The information in this guide applies to all Ansys, Inc. products released on or after this date, until superseded
by a newer version of this guide.

Copyright and Trademark Information

© 2022 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

ANSYS, Ansys Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.

Disclaimer Notice

THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.

ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.

U.S. Government Rights

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).

Third-Party Software

See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.

Published in the U.S.A.

Table of Contents
1. Introduction ............................................................................................................................................ 1
1.1. Configuring Elastic Licensing in Windows .......................................................................................... 1
1.1.1. Accessing the Ansys Client Settings Utility ................................................................................ 1
1.1.2. Changing the Elastic Licensing PIN .......................................................................................... 1
1.1.3. Disabling Elastic Licensing ........................................................................................................ 2
1.1.4. Gathering Diagnostics Data ...................................................................................................... 2
1.2. Configuring Elastic Licensing in Linux ................................................................................................ 2
1.2.1. Changing the Elastic Licensing PIN ........................................................................................... 2
1.2.2. Disabling Elastic Licensing ........................................................................................................ 3
1.3. Configuring the Usage Tracking Environment Variables ..................................................................... 3
1.3.1. Setting the Usage Tracking Environment Variables .................................................................... 4
1.4. Troubleshooting ............................................................................................................................... 5
1.4.1. Understanding Error Codes ...................................................................................................... 5
1.4.2. Failover Feature Not Available .................................................................................................. 5

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
information of ANSYS, Inc. and its subsidiaries and affiliates. iii
 Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
iv information of ANSYS, Inc. and its subsidiaries and affiliates.
List of Tables
1.1. Environment Variable Configuration Options ........................................................................................... 4

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
information of ANSYS, Inc. and its subsidiaries and affiliates. v
 Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
vi information of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 1: Introduction
This guide contains detailed instructions describing client-side functions available with Ansys Elastic
Licensing.

1.1. Configuring Elastic Licensing in Windows

The following sections describe how to configure elastic licensing in Windows using the functionality
available through the Ansys Client Settings utility.

1.1.1. Accessing the Ansys Client Settings Utility

1. To access the Ansys Client Settings Utility, navigate to the following directory:

< Ansys Licensing Installation Drive>\Program Files\Ansys Inc\<release>\licensingclient\winx64\Cli-

entSettings

2. Run the ClientSettings.exe file.

1.1.2. Changing the Elastic Licensing PIN

If license administrator changes the PIN of the Cloud License Server, client-side users on Windows
should perform the following steps:

1. Have your elastic licensing administrator provide you with a .json file containing your Cloud License
Server ID and your Cloud Server License PIN.

2. Open the Ansys Client Settings utility.

3. Click the Cloud License Server option.

4. Click Enable Elastic Licensing.

5. Click Chose File, browse to the directory containing json file supplied by your elastic licensing
administrator, select the file and click Open.

6. An informational message is displayed “You are uploading a file that will change your CLSID and
CLS PIN. Do you want to continue?”. Click OK.

Your ansyslmd.ini file is updated, and the ID and PIN are displayed in the Ansys Licensing Client
Settings utility. You can locate your ansyslmd.ini file in the following directory:

<Ansys Licensing Installation Drive>\Program Files\Ansys Inc\Shared Files\Licensing\ansyslmd.ini

For more information on the changing the Cloud License Server PIN, see the Ansys Elastic Licensing
Administrator's Guide and Getting Started with Ansys Elastic Licensing.

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
information of ANSYS, Inc. and its subsidiaries and affiliates. 1
Introduction

1.1.3. Disabling Elastic Licensing

When Elastic Licensing is enabled, the Ansys applications will consume the available local licenses (if
a local License Manager is configured) before consuming Ansys Elastic Units from the Cloud License
Server. If you disable Elastic Licensing, your Ansys applications will continue to use licenses from your
local license manager but will not attempt to consume elastic licenses from the Cloud License Server.

1. Open the Ansys Client Settings utility.

2. Click the Cloud License Server option.

3. Click Disable Elastic Licensing.

1.1.4. Gathering Diagnostics Data

This option gathers elastic licensing-related data about your system and places in a single compressed
file. This information is useful when requesting support for elastic licensing. To gather the data:

1. Open the Ansys Client Settings utility.

2. Click the Gather Diagnostics option.

3. Click Generate.

The diagnostic data is displayed in the Console area and a compressed file containing this data
is saved to:

<Product Installation Drive>\Users\<User Name>\AppData\Local\Temp\

1.2. Configuring Elastic Licensing in Linux

The following sections describe how to configure elastic licensing in Linux.

1.2.1. Changing the Elastic Licensing PIN

If license administrator changes the PIN of the Cloud License Server, client-side users on Linux should
perform the following steps:

1. Have your elastic licensing administrator provide you with a .json file containing your Cloud License
Server ID and your Cloud Server License PIN.

2. Open the Ansys Client Settings utility.

3. Click the Cloud License Server option.

4. Click Enable Elastic Licensing.

5. Click Chose File, browse to the directory containing json file supplied by your elastic licensing
administrator, select the file and click Open.

6. An informational message is displayed “You are uploading a file that will change your CLSID and
CLS PIN. Do you want to continue?”. Click OK.

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
2 information of ANSYS, Inc. and its subsidiaries and affiliates.
 Configuring the Usage Tracking Environment Variables

Your ansyslmd.ini file is updated, and the ID and PIN are displayed in the Ansys Licensing Client
Settings utility. You can locate your ansyslmd.ini file in the following directory:

<Ansys Licensing Installation Drive>\Program Files\Ansys Inc\Shared Files\Licensing\ansyslmd.ini

For more information on the changing the Cloud License Server PIN, see the Ansys Elastic Licensing
Administrator's Guide and Getting Started with Ansys Elastic Licensing.

1.2.2. Disabling Elastic Licensing

When Elastic Licensing is enabled, the Ansys applications will consume the available local licenses (if
a local License Manager is configured) before consuming Ansys Elastic Units from the Cloud License
Server. If you disable Elastic Licensing, your Ansys applications will continue to use licenses from your
local license manager but will not attempt to consume elastic licenses from the Cloud License Server.

1. Locate and open the ansyslmd.ini file. This file should be found in the following directory:

Windows:

<Ansys Licensing Installation Drive>\Program Files\Ansys Inc\Shared Files\Licensing\ansyslmd.ini

Linux:

/ansys_inc/shared_files/licensing/ ansyslmd.ini

2. Add the pound symbol (#) in front to the ANSYS_ELASTIC_CLS keyword.

#ANSYS_ELASTIC_CLS=CLSID:PIN

3. Save your changes to the ansyslmd.ini file.

1.3. Configuring the Usage Tracking Environment Variables

The following usage tracking environment variables are used to aid better tracking of the Elastic unit
usage. Each of these variables can be set at the individual user level (user variables), entire system level
(system variables) and install level (ansyslmd.ini file).

ANSYS_ELASTIC_PROJECT
Description: When enabled, this optional variable displays the elastic project in the usage extracts so
you can identify the usage for a defined project.

Example: ANSYS_ELASTIC_PROJECT=WB_SIMULATION_COMPANY_A

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
information of ANSYS, Inc. and its subsidiaries and affiliates. 3
Introduction

1.3.1. Setting the Usage Tracking Environment Variables

The usage tracking environment variables can be set at three levels to customize the usage tracking
displayed on the Ansys Elastic Licensing Portal.

Table 1.1: Environment Variable Configuration Options

Option:
User Environment Variable
System Environment
Variable
ansyslmd.ini Keyword
Tracking:
Setting the variable at the user level allows you to track the elastic license
usage of individual user.
Setting the variable at the system level allows you to track the elastic
license usage for all users on a specific computer.
Setting the variable at the ansyslmd.ini file level allows you to track elastic
usage for a specific Ansys product installation.

Setting the User Environment Variable

To set the variable Windows:

1. From the Control Panel, select:

System and Security>System>System Settings>Advanced System Settings

2. Click Environment Variables.

3. Under the User variables, click New.

4. Enter the Variable name and the Variable value.

5. Click OK in each window displayed to accept the new environment variable.

To set the variable Linux:

Enter the command:

• setenv <Usage Tracking Environment Variable>

OR

• export <Usage Tracking Environment Variable> (Depending on the shell you are using.)

Setting the System Environment Variable

To set the variable Windows:

1. From the Control Panel, select:

System and Security>System>System Settings>Advanced System Settings

2. Click Environment Variables.

3. Under the System variables, click New.

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
4 information of ANSYS, Inc. and its subsidiaries and affiliates.
 Troubleshooting

4. Enter the Variable name and the Variable value.

5. Click OK in each window displayed to accept the new environment variable.

1.4. Troubleshooting
This chapter lists problems and error messages that you may encounter while setting up licensing. After
each situation description or error message is the user action required to correct the problem.

1.4.1. Understanding Error Codes

Incorrect CLSID
Cause: The CLS not defined or unknown to/accessible from LaaS

Error displayed: Cloud License Server with id <LaasSessionClsId> is not known to the Ansys Licensing
as a Service application, please verify that the id was entered correctly. If it has please contact our
administrator to verify you have the correct id.

Incorrect PIN
Cause: The CLS PIN not defined or unknown to/accessible from LaaS

Error displayed: Invalid PIN passed for Cloud License Server <LaasSessionClsId>, unable to complete
requested action.

PIN not yet configured

Cause: The PIN not available for the CLS.

Error displayed: No PIN has been assigned for Cloud License Server <LaasSessionClsId>, please have
your administrator log into the Ansys Elastic Licensing Portal to assign a PIN.

Client machine is not on the CLS White List

Cause: Your client machine is not in the white list for the CLS.

Error displayed: Your external IP has not been included on the white list for Cloud License Server
<LaasSessionClsId>, please contact your administrator to add your external IP to the white list.

Session is in Deleted Status

Error displayed: Session id <LaasSessionId> has been deleted from LaaS, unable to complete
checkout action for feature xyz.

1.4.2. Failover Feature Not Available

Elastic Licensing fails on SuSE Linux platforms with the following error message:

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
information of ANSYS, Inc. and its subsidiaries and affiliates. 5
Introduction

Error displayed:

Failover feature <Ansys Product Name> is not available. Curl Error (77) Problem with the SSL CA cert
(path? access rights?) - error setting certificate verify locations:

CAfile: /etc/ssl/certs/ca-bundle.crt

CApath: /etc/ssl/certs/

Solution:

Set the following env varable on the system before running the applciation:

ANSYSLS_CLIENT_CA_PATH=/etc/ssl/certs/DigiCert_Global_Root_CA.pem

Release Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential
6 information of ANSYS, Inc. and its subsidiaries and affiliates.