Synopsys Licensing QuickStart

All Customers

SCL 2022.12 is recommended for all customers.  It has important enhancements, including a fix for a midnight reread issue that might in some cases cause reservations to be lost.  See the Release Notes
for a list of enhancements as well as supported OS information.

Cloud Customers

Cloud customers who are not using at least SCL 2021.12-SP2 should move to SCL 2022.12.  SCL 2021.12 has important cloud-related enhancements, including a stable FlexNet 11.19.1 version of the FlexNet Licensing Service (FNLS) required for the cloud.

Download

For entitled customers, SCL 2022.12 is available in the SolvNetPlus Download Center (from the list of products, choose Synopsys Common Licensing; Linux users will also need Synopsys Installer).

Alternate Download

New customers and other non-entitled customers with a SolvNetPlus username and password may download SCL and Installer via the EFT Public folder:

• Browse to https://eft.synopsys.com
• Login with your Synopsys SolvNetPlus username and password to login.
• Click Public > scl_v2022.12 to download the SCL binaries
• Click Public > installer_v5.6 to download Synopsys Installer (required for Linux only)
  

Documentation 

• SCL 2022.12 Release Notes (SolvNet username and password required)
• SCL 2022.12 Administration Guide (SolvNet username and password required)
• Installation Guide for SCL & Synopsys Tools
• FlexNet License Administration Guide

SCL QuickStart Setup Instructions
In this Licensing QuickStart Guide you will find Synopsys Common Licensing 2021.12 download and setup instructions.

Pre-Installation

• Retrieve Your Keys
  
• Hardware & OS Requirements
• Determining the License Server Hostid
• Ordering a USB dongle
• Determining Your Current SCL Version

Installation, Configuration & Start-Up

• Downloading & Installing SCL (lmgrd, snpslmd)
• Downloading Your License Key File
• Customizing the License Key File
• Starting the License Server
• Setting Up the User Environment to Access the Key File

Troubleshooting (SolvNet password might be required)

• Enable Enhanced SCL Server/Client Logging Capabilities
• Resolving SSS / sssverify Errors
• Dongle Setup & Troubleshooting (Windows)
• lmgrd Error Message: "Failed to open the TCP port number in the license"
• snpslmd Error Message: lmgrd Refused Vendor Name List

Determining Your Current SCL Version

• To determine your SCL version, do the following:

  % cd scl_root/<platform>/bin
  % ./whatscl snpslmd

  ==> Synopsys Corporate Licensing (SCL) Release: version SCL 2022.12 ...
  
• Alternately, on Linux (only), you may determine your SCL version via the Linux strings command:

  % strings /path/to/snpslmd | grep Release

  Note that these results give the Synopsys version, not the FlexNet version. The FlexNet version for SCL 2022.12 is 11.19.1 (lmgrd, snpslmd, lmstat, etc.)

Installation, Configuration & Startup

1. Downloading & Installing SCL
2. Download your Synopsys key file from SmartKeys
3. Customize the key file
4. Start SCL

Downloading & Installing SCL

To download SCL via Electronic Software Transfer

• Point your web browser to https://solvnet.synopsys.com/DownloadCenter
• If required, enter your Synopsys SolvNet username and password.
• Under My Product Releases, choose Synopsys Common Licensing.
• Choose  2022.12 from the list of available versions.
• Click Download Here to download SCL by HTTPS.
• After reading the legal page, click "Agree and Sign In." 
• Click the checkbox at the far left of each file name you wish to download.
  • Windows users must choose the scl_v2022.12 file
  • Linux users must choose the scl_v2022.12_common.spf and scl_v2022.12_linux64 files.
• At the top right, click Download File(s) to download the selected files.Follow the browser prompts to select a destination download directory.
• This directory should be a temporary directory and not the target installation directory.

To download the Synopsys Installer (Linux only)

• Point your web browser to https://solvnet.synopsys.com/DownloadCenter
• If required, enter your Synopsys SolvNet username and password.
• Under My Product Releases, choose Synopsys Installer.
• After reading the legal page, click "Agree and Sign In."
• Choose the latest product version (e.g., "5.6") from the list of available versions.
• Click Download Here to download the Synopsys Installer by HTTPS.
• After reading the legal page, Click "Agree and Sign In."
• Click the checkbox next to the SynopsysInstaller_v5.56run file.
  
• Follow the browser prompts to select a destination download location.

To install SCL (Linux only)

• % chmod 755 SynopsysInstaller_v5.6.run
• % ./SynopsysInstallerv_5.6.run # extracts the installer to the current dir
• Make sure the SCL product files (for example, scl_v2022.12_common.spf and scl_v2022.12_linux64.spf) are in a temporary directory.
• From the directory where you extracted installer, type "installer" or "installer -gui" to start the installation.
• Enter the path to the temporary (source) directory containing the SCL *.spf files.
• Follow the prompts. When asked, enter the path to the target directory.
  (For SCL, this should be a local path / mount and not an NFS mount.)

For more details on installing SCL, see the "Installing Synopsys Tools" and "Synopsys Common Licensing" chapters of the Installation Guide, available at http://www.synopsys.com/install.

Download Your Site's License Key File

Before starting the lmgrd license daemon, you must retrieve your license key file from the SmartKeys Web page. Complete these steps to get your license key file using the Web:

1. Navigate to SmartKeys: https://solvnet.synopsys.com/SmartKeys 
   
2. If requested, enter your Synopsys (SolvNet) username and password
3. At the SmartKeys main screen, click Key Retrieval.
4. Under Site ID, select the correct Synopsys Site ID.

   If you do not know your Site ID, obtain your Site ID in one of the following ways:

   • View the site_info file in your tool tree ($SYNOPSYS/admin/license/site_info). The SiteID field identifies your Site ID.
   • Look at an old Synopsys key file. Near the top, you will find your Site ID.
     # SYNOPSYS INC. KEY CERTIFICATE
     # Site Id: xxxx [where xxxx is a number]
5. Click Continue. SmartKeys processes your request and sends you the license key file by e-mail.

Verify the hostid 

Your license key file, as received from SmartKeys, will look something like this:

#---------------------------------------------------------------
SERVER hostname1 0128D07E321F 27020
VENDOR snpslmd /path/to/snpslmd
USE_SERVER
INCREMENT SSS snpslmd 1.0 05-dec-2024 1 3EE593F14EED \
VENDOR_STRING="382be a5896 de613 1618c 27e26 40bb1 40cec 13318 8da63 128" \
NOTICE="Licensed to ABC Corporation [PLEASE DO NOT DELETE THIS SSS KEY]" \
SN=RK:0:0:802047 ISSUER="Synopsys Inc." \
START=06-dec-2021
INCREMENT PrimeTime snpslmd 2022.12 05-dec-2024 10 VENDOR_STRING=^1+S \
SUPERSEDE ISSUED=06-dec-2022 ck=115 SN=RK:3222-0:733381:117716 \
START=06-dec-2021 AUTH={ snpslmd=( LK=6D8411D4365F7D1C39DB)}
[...]
#----------------------------------------------------------------

Check the SERVER line of the license file (in the above example, 0128D07E321F) to verify it is correct.  Compare the hostid with the hostid in your previous license file.  Or, run the lmhostid command to ensure that the hostid matches. 

IMPORTANT:  For the Cloud, the MAC address is not an accepatable hostid.  Instead, you must start the FNLS cloud service included with SCL and then use the VM_UID (all clouds) or the AMZN_EIP hostid (AWS only).  The syntax is "lmhostid -ptype VM -uuid" -OR- "lmhostid -ptype AMZN -eip".  For more details, see the SCL Admin Guide, Chapter 6, Using SCL License Server in a Cloud Environment.

If the hostid information is incorrect, you must not modify the key file hostid as it is encrypted into every key. (Instead, contact you Synopsys Account Manager to request a new file. If a Synopsys mistake was not made, a "rehost form" may be required. Only on-support keys may be rehosted.)

Customize the License Key File

Before you can use the Synopsys license key file downloaded from Smartkeys, it must be customized for your site.  For both Linux and Windows license servers, follow the steps below.

1. Place the license key file on your system.

   The recommended key file location is: scl_root/admin/license/*.lic

   Example:

   • Linux: /synopsys/scl/admin/license/synopsys.lic
   • Windows: C:\Synopsys\SCL\2022.12\admin\license\synopsys.lic
2. Make sure the key file is formatted properly.
   • Do NOT remove the USE_SERVER line.
     This keyword should exist, on a line by itself, before any cvd-format INCREMENT lines.
   • Remove any VENDOR or DAEMON lines for non-snpslmd vendor daemons. These are not allowed.
   • All lines should start with SERVER, VENDOR, USE_SERVER, PACKAGE, INCREMENT, or #
   • Lines may only wrap after a space and a continuation character (" \")
   • All comment lines must start with #
3. Verify the accuracy of the license file.

   Run "sssverify" to verify the integrity of the license file (sssverify is included with SCL).
   The syntax is "sssverify /path/to/synopsys.lic".

   Note: If any keys have been added or removed from the key file (except for temp keys), sssverify will fail.
4. Modify the SERVER line(s).

   The SERVER line of your key file has the following syntax:
   SERVER hostname1 hostid tcp_port_number

   Note:  Redundant server setups (supported only for non-cloud machines) have three SERVER lines. For this setup, it is important to add the PRIMARY_IS_MASTER keyword to the end of the SERVER line that denotes the master server (this is normally the first server on the list of servers).

    

   Mandatory

   On the SERVER line, modify the hostname1 argument with the value returned
   by the Linux hostname command.

   Note: The hostid in the license key file (0128D07E321F in this example) must match your machine
   hostid.  
5. Note: Cloud machines do not use the ethernet (MAC) address hostid but a virtual hostid such as VM_UUID.  For details, see Chapter 6 of the SCL Administration Guide.
6. as determined by the scl_root/<platform>/bin/lmhostid command.

   Do not change the hostid. If you change the hostid, you will invalidate your license key file.
   If the hostid is incorrect, contact your account manager to request a new license key file.
   

   Optional

   Modify the TCP port number (the Synopsys default is 27020) to any available TCP port between 1024 and 64000. (For performance reasons, ports 27000-27009 are not recommended for the lmgrd port.)

   Example:

   SERVER aspen 0128D07E321F 27020

7. Modify the VENDOR line.

   The VENDOR line has the following syntax:
   VENDOR snpslmd /path/to/snpslmd [ /path/to/options_file ]

   Mandatory

   Specify the full path to snpslmd

   Examples:
   Linux:
   VENDOR snpslmd /synopsys/scl/2022.12/linux64/bin/snpslmd
   Windows:
   VENDOR snpslmd C:\Synopsys\SCL\2022.12\win32\bin\snpslmd.exe

   Optional
   

   Add the path to any license option file(s) after the vendor daemon path.  For example,
   VENDOR snpslmd /synopsys/scl/2022.12/linux64/bin/snpslmd \
   /synopsys/scl/2022.12/linux64/bin/snpslmd.opt
   

   Recommended
   

   Add port=nnnn (example: port=27021) to the end of the VENDOR line.

8. After modifications, the sample key file would look like this (changes in bold):

   SERVER aspen 0128D07E321F 27020
   VENDOR snpslmd /synopsys/scl/2022.12/linux64/bin/snpslmd port=27021
   USE_SERVER
   INCREMENT SSS snpslmd 1.0 05-dec-2024 1 3EE593F14EED \
   VENDOR_STRING="382be a5896 de613 1618c 27e26 40bb1 40cec 13318 8da63 128" \
   NOTICE="Licensed to ABC Corporation [PLEASE DO NOT DELETE THIS SSS KEY]" \
   SN=RK:0:0:802047 ISSUER="Synopsys Inc." \
   START=06-dec-2021
   INCREMENT PrimeTime snpslmd 2022.12 05-dec-2024 10 VENDOR_STRING=^1+S \
   SUPERSEDE ISSUED=06-dec-2022 ck=115 SN=RK:3222-0:733381:117716 \
   START=06-dec-2021 AUTH={ snpslmd=( LK=6D8411D4365F7D1C39DB)}
   [...]
   #---------------------------------------------------------

9. Save your change.

   You are now ready to start the license server.

Start the License Server

To start SCL, all legacy vendor daemons must be shut down. For a full list of legacy daemons incorporated into SCL, click here.

Cloud Users: Before you start SCL, the FlexNet Publisher Licensing Service (FNLS) must be running.

The FNLS installation executable is included with SCL in the scl_root/platform/bin directory.
For Linux, run "install_fnp --cert".  For Windows, go to the Windows Powershell (admin) prompt and run "installanchorservice snpslmd all".

For more details on the FNLS cloud service, including requires OS patches, see the cloud chapter of the SCL Admin Guide, which is included with SCL in the doc subdirectory.

Choose your license server OS:

• Linux
• Windows

Starting a License Server under Linux

To shut down the currently running SCL or legacy daemon process(es), enter the following command:

% scl_root/platform/bin/lmdown -c /path/to/key file

1. To start the SCL (snpslmd) licensing daemon, use the following command syntax:
   

   lmgrd -c license_key file_name -l debug_log_filename

   For example, on the Linux platform (64-bit kernel), enter:

   % scl_root/linux64/bin/lmgrd -c scl_root/admin/license/synopsys.lic \
   -l scl_root/admin/logs/snps.debug.log

2. Once you have started lmgrd, check the debug log file (here "snps.debug.log") for errors.
   Check the time-stamped entries to verify that
   • lmgrd (FlexNet Licensing) 11.19.1 or higher has started <--FlexNet version
   • SCL version SCL 2022.12 has started <--Synopsys version
   • there are no SSS security errors ("Invalid license file fingerprint" or "WARNING: SSS errors").
   • the list of available features (keys) is correct

   The debug log file should show that the snpslmd daemon has started, followed by a list of
   available features (that is, keys or INCREMENT lines).

3. Your Linux license server will now be able to serve any clients on the network,
   client operating system.
4. For each client, set a licensing environment variable (see next section).
   
5. So you don't have to manually start lmgrd every time you reboot your license server, you will need
   a Synopsys license server boot script. For a boot script that you may modify to fit your needs,
   retrieve the SolvNet article, Boot Script for Synopsys License Servers.

Starting a License Server under Windows

For a given vendor daemon each license server host can have only one active vendor daemon process. Before starting SCL, make sure to shut down snpslmd:

• Start lmtools (Start > Synopsys SCL > lmtools 2022.12
• Click the Service/License File tab and choose Configure using Services
• Select the correct service name(s)
• Click the Start/Stop/Reread tab and choose Stop Server

To start the licensing daemon, follow the steps below.

1. In File Explorer, double-click the lmtools.exe utility.
   
2. Click System Settings.
   • Make sure the Ethernet Address is correct and matches your key file's SERVER hostid
   • If you are using a dongle, make sure the FLEXid is correct. If no FLEXid shows
     in the "FLEXID" window, see the article on Dongle Setup & Troubleshooting. 
     
3. Click Services/License File.

   Make sure Configure using Services is selected.

4. Click Configure Services.
   • Under Service Name, type in an arbitrary service name (for example, "Synopsys Licensing").
   • Next to "Path to the lmgrd.exe file," click Browse and browse to lmgrd.exe.

     For example, browse to C:\Synopsys\SCL\2022.12\win32\bin\lmgrd.exe 

   • Next to "Path to the license file," click Browse and browse to the Synopsys key file.

     For example, browse to C:\Synopsys\SCL\2022.12\admin\license\synopsys.lic.

   • Next to "Debug Log File," type the path to create a debug.log file.
     (This file should be in the C:\ProgramData\FNP_DIR directory.)
     

     For example, type C:\ProgramData\FNP_DIR\synopsys.log  
     At the bottom of the window, check Use Services and Start Server at Power-Up.
     

   • This will ensure that the Synopsys license server starts automatically every time the system is booted.

   • Click Save Service to save you changes.
5. Click the Start/Stop/Reread tab and click Start Server to Start the License Server.
6. Verify that the SCL license server has started correctly:

• Click Configure Services.
• Click View Log to view the debug.log file.
• Check the time-stamped entries to verify that
• lmgrd (FlexNet Licensing) v11.19.1 has started <--FlexNet version
• SCL version 2022.12 has started <--Synopsys version
• there are no security errors ("Invalid license file fingerprint" or "WARNING: SSS errors")
• the list of available (started) keys is correct

For example:

17:09:39 (lmgrd) Done rereading 
17:09:39 (lmgrd) FlexNet Licensing ( v11.19.1 build 25247 i86_lsb) started on my_server
17:09:39 (lmgrd) License file(s): C:\synopsys\scl\2022.12\admin\logs\synopsys.lic
17:09:39 (lmgrd) lmgrd tcp-port 27020 
17:09:39  (lmgrd) Server's System Date and Time: Tue Dec 6 2022 13:05:19 PST
17:09:39  (lmgrd) SLOG: Summary LOG statistics is enabled.
17:09:39   (lmgrd) FlexNet Licensing (v11.19.1 build 25247 x64_lsb) started on jove (linux)
17:09:39   (lmgrd) Copyright (c) 1988-2021 Flexera Software LLC. All Rights Reserved.
17:09:39   (lmgrd) World Wide Web:  http://www.flexerasoftware.com
17:09:39   (lmgrd) License file(s): jove.lic
17:09:39   (lmgrd) lmgrd tcp-port 27020
17:09:39   (lmgrd) (@lmgrd-SLOG@) ===============================================
17:09:39   (lmgrd) (@lmgrd-SLOG@) === LMGRD ===
17:09:39   (lmgrd) (@lmgrd-SLOG@) Start-Date: Mon Tue Dec 6 2022 13:05:19 PST
17:09:39   (lmgrd) (@lmgrd-SLOG@) PID: 15293
17:09:39   (lmgrd) (@lmgrd-SLOG@) LMGRD Version: v11.19.1 build 25247 x64_lsb ( build 25247 (ipv6))
…
17:09:39   (lmgrd) (@lmgrd-SLOG@) Listening port: 27020
…
17:09:39  (lmgrd) Starting vendor daemons ...
17:09:39  (lmgrd) Using vendor daemon port 27021 specified in license file
17:09:39  (lmgrd) Started snpslmd (internet tcp_port 27021 pid 15294)
17:09:39  (snpslmd) FlexNet Licensing version v11.19.1 build 212549 x64_lsb
17:09:39 (snpslmd) INFO: QUEUING enabled when MAX option is set (SCL_QUEUE_ON_MAX=1)
17:09:39 (snpslmd) INFO: Pooling on VENDOR_STRING is Disabled (to enable, set SCL_POOL_VS=1)
17:09:39 (snpslmd) Synopsys Corporate Licensing (SCL) Release: version SCL_2022.12
17:09:39 (snpslmd) [SCL] File descriptor limit (soft, hard) for snpslmd:  32768,65536 
17:09:39 (snpslmd) INFO: [SCL] TCP - tcp_keepalive_time - 900 | tcp_keepalive_intvl - 60 | tcp_keepalive_probes - 10 | tcp_fin_timeout - 6
17:09:42 (snpslmd) Server started on my_server for: 
17:09:42 (snpslmd) DC-Expert DC-Ultra-Features
17:09:42 (snpslmd) DC-Ultra-Opt Design-Compiler
17:09:42 (snpslmd) Design-Vision DesignWare 
17:09:42 (snpslmd) Designware-Basic HDL HDL-Compiler
17:09:42 (snpslmd) PrimeTime-ADV PrimeTime-ADV-PLUS
17:09:42 (snpslmd) PrimeTime PrimeTime-SI
17:09:42 (lmgrd) snpslmd using TCP-port 27021
17:09:42 (snpslmd) Serving features for the following vendor names:
snpslmd ACAD adalmd anagram arcd atrenta avantd CADABRA chrysalisd
cowared doradod EPIC eved extremed hscd innologd ISE-TCADd knights
magma metasoftd mwflexd nassd nsysnvs numeritchd pdld perflmd riod  
saber_dmn sandwork sclmgrd sigmacd SIINT simple snpsOEM1 snslmgrd
ssilmd synforad synopsysd synplctyd targetld TAVEREN TE_CATS tmald
vastlmd vcsd wlld

Your SCL license server will now be able to serve any clients on the network.

Set Up the User Environment to Access the Key File

For each user account that will be running the Synopsys tools, set a licensing environment variable.
The licensing variable is a pointer that tells the Synopsys tools where to find the license file.

Licensing variables include

• SNPSLMD_LICENSE_FILE
• LM_LICENSE_FILE (all tools)
  

Environment Variable Set-Up Examples:

• Linux
• Windows

Setting up the User Environment under Linux

Set SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE (SNPSLMD_LICENSE_FILE is preferred.)

• C-Shell

  Add to Synopsys source file or .cshrc:

  setenv SNPSLMD_LICENSE_FILE 27020@aspen
  [port@host syntax--where 27020 is the TCP port specified in the license file and"aspen" is the hostname]

  NOTE:  For multiple license servers, separate port@host server references with a colon. 
  If you are using triple redundant servers, separate the references with a comma.

• Bash shell

  Add to Synopsys source file,  .bashrc,  or .profile:

  export SNPSLMD_LICENSE_FILE=27020@aspen

Setting up the User Environment under Windows

1. Click Start > Settings,
   
2. In the Find a Settings search box, type "Control Panel".
3. In Control Panel, click System > Advanced > Environment Variables.
4. Under System Variables, click New (to create a new variable) or Edit (to edit an existing variable).
5. Under Variable Name, enter SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE
   (SNPSLMD_LICENSE_FILE is preferred).
6. Under Variable Value, enter the correct port@host information.

Example: