FlexLM Options File: Getting Started Guide

Using FlexLM Options Files for STK and ODTK on Ansys License Server

FlexLM Options files are useful for managing the usage of licenses in a networked environment. They help in defining rules for which users or hosts can access specific features, reserving licenses for particular users or groups, and limiting the number of licenses.

Purpose of Options Files

1. User and Group Control: Specify which users or groups can access particular licenses.
2. License Reservation: Reserve licenses for specific users or groups.
3. License Limiting: Limit the number of licenses that can be used by certain users or groups.
4. License Denial: Deny access to certain users or groups.

Key Options in FlexLM Options Files

1. GROUP and HOST_GROUP: Define groups of users or hosts.
   • GROUP group_name user_list
   • HOST_GROUP host_group_name host_list
2. INCLUDE: Allow specified users or groups to use a feature.
   • INCLUDE feature_name {USER | HOST_GROUP | GROUP} group_name
3. EXCLUDE: Prevent specified users or groups from using a feature.
   • EXCLUDE feature_name {USER | HOST_GROUP | GROUP} group_name
4. RESERVE: Reserve licenses for specified users or groups.
   • RESERVE num_licenses feature_name {USER | HOST_GROUP | GROUP} group_name
5. MAX: Limit the number of licenses a user or group can check out.
   • MAX num_licenses feature_name {USER | HOST_GROUP | GROUP} group_name
6. DENY: Deny specified users or groups access to a feature.
   • DENY feature_name {USER | HOST_GROUP | GROUP} group_name

Creating a FlexLM Options File

To create a FlexLM Options file for STK and ODTK products, follow these steps:

1. Open a Text Editor: Use any text editor like Notepad (Windows), TextEdit (Mac), or vi/nano (Linux) 
2. Build the License Content: (All the content is optional but based on the needs)

• Define Groups (Optional):
  1. GROUP engineers user1 user2 user3 
  2. GROUP analysts user4 user5 user6 
• Include or Exclude Users/Groups:
  1. INCLUDE stk_mission_level1 GROUP engineers 
  2. EXCLUDE stk_mission_space USER user6 
• Reserve Licenses:
  1. RESERVE 2 stk_mission_level1 GROUP engineers 
• Limit License Usage:
  1. MAX 1 stk_mission_level2 USER user5 
• Deny Access:
  1. DENY stk_mission_space USER user6 

1. Apply the Options File
   1. Save the file with an .opt extension. 
      1. File Name: ansylmd.opt which is the same name as the Ansys License File (usually). 
      2. Location: C:\Program Files\ANSYS Inc\Shared Files\licensing\license_files which is where the Ansys licenses are located on Windows. 
   2. Restart License Server: Restart the FlexLM license server to apply the new settings. This can typically be done via command line or through an administrative interface provided by the software vendor.

Example Options File for STK and ODTK

Below is an example of a complete FlexLM Options file tailored for STK and ODTK products:

Example 1: User-Specific Access

Requirement: Bob should have access to STK Pro and SOLIS only, while Erica should have access to Premium Space without SOLIS.

# Define user groups 

GROUP BobGroup bob 

GROUP EricaGroup erica 

# Include Bob in STK Pro and SOLIS 

INCLUDE stk_mission_level1 GROUP BobGroup 

INCLUDE stk_engine_runtime GROUP BobGroup 

INCLUDE stk_solis GROUP BobGroup 

# Include Erica in Premium Space excluding SOLIS 

INCLUDE stk_mission_level1 GROUP EricaGroup 

INCLUDE stk_engine_runtime GROUP EricaGroup 

INCLUDE stk_mission_level2 GROUP EricaGroup 

INCLUDE stk_mission_space GROUP EricaGroup 

INCLUDE stk_snopt GROUP EricaGroup 

INCLUDE stk_satcollection GROUP EricaGroup 

EXCLUDE stk_solis GROUP EricaGroup 

Example 2: License Reservation

Requirement: Reserve 1 license for Premium Space for Operations1 and reserve 2 Pro licenses for Marketing1 and Marketing2 machines.

# Define host groups 

HOST_GROUP OperationsGroup Operations1 

HOST_GROUP MarketingGroup Marketing1 Marketing2 

# Reserve licenses for Operations1 

RESERVE 1 stk_mission_level1 HOST_GROUP OperationsGroup 

RESERVE 1 stk_engine_runtime HOST_GROUP OperationsGroup 

RESERVE 1 stk_mission_level2 HOST_GROUP OperationsGroup 

RESERVE 1 stk_mission_space HOST_GROUP OperationsGroup 

RESERVE 1 stk_snopt HOST_GROUP OperationsGroup 

RESERVE 1 stk_satcollection HOST_GROUP OperationsGroup 

# Reserve licenses for Marketing1 and Marketing2 

RESERVE 1 stk_mission_level1 HOST_GROUP MarketingGroup 

RESERVE 1 stk_engine_runtime HOST_GROUP MarketingGroup 

Example 3: Limiting License Usage

Requirement: Limit the number of STK Scheduler licenses that can be checked out by any user to 2 at a time.

# Limit license usage for STK Scheduler 

MAX 2 stk_scheduler USER ALL 

Example 4: Deny Access

Requirement: Deny access to ODTK products for user Dave.

# Define user group 

GROUP DaveGroup dave 

# Deny access to ODTK products for Dave 

DENY odtk_level1 GROUP DaveGroup 

DENY odtk_level2 GROUP DaveGroup 

Name of Product and Associated Features

Below is a list of Ansys products (AGI only) and their associated features:

1. Ansys STK Pro
   • stk_mission_level1
   • stk_engine_runtime
2. Ansys STK Premium Space:
   • (All Features in STK Pro) 
   • stk_mission_level2
   • stk_mission_space
   • stk_snopt
   • stk_satcollection
3. Ansys STK Premium Air
   • (All features in STK Pro)
   • stk_mission_level2
   • stk_mission_air
4. Ansys STK Enterprise 
   • (All features in STK Pro + Premium Air + Premium Space)
   • stk_geoserver
   • stk_geodata
   • stk_data_federate
   • moxie_sysml
5. Ansys STK SOLIS:
   • stk_solis
6. Ansys STK Scheduler:
   • stk_scheduler
7. Ansys ODTK:
   • odtk_level1
   • odtk_level2
8. Ansys ODSSA:
   • odtk_comspoc
   • odtk_maneuver
9. Ansys STK RF Channel Modeler:
   • stk_rfchannel_ent
   • stk_gpusbr_p2p

By using FlexLM Options files, you can effectively manage and optimize the usage of your licensed software, ensuring compliance with licensing agreements and improving operational efficiency.