Synopsys Licensing QuickStart Guide 

SCL 11.9 will be released in December 2014  

All Customers
SCL 11.8 or 11.9 will be required to run March 2015 Synopsys tool releases. (SCL 11.9 will be released on December 8, 2014, and is recommended for all customers.) Please plan your migration to SCL 11.9 now.

Target Compiler Technologies Customers
On December 8, 2014, Synopsys Common Licensing 11.9 will be released. SCL 11.9 is recommended for all customers but will be required for Target Compiler customers. For more details, see The Target Compiler migration page.

In this Licensing QuickStart Guide you will find Synopsys Common Licensing 11.8 download and setup instructions. Synopsys Common Licensing 11.8 is based on FLEXnet 11.12.1 technology. (SCL 11.8 is required for PerfectVIPs customers. Also, either SCL 11.8 or 11.9 will be required to run March 2015 release tools.)

PerfectVIPs Customers
In June 2014, PerfectVIPs keys were reissued in the standard cvd format. SCL 11.8 or later is required for any keys issued on or after June 6, 2014 that reference the perflmd vendor daemon. For more information on the PerfectVIPs product migration to SCL & cvd, click here.)

SpringSoft Customers
Synopsys Common Licensing (SCL) 11.6 or later is required for compatibility with Synopsys/SpringSoft tools based on the sclmgrd and snslmgrd vendor daemons.

SCL Release Notes
For information on the fixes and enhancements in the SCL 11.8 release, see the SCL 11.8 release notes.
For information on the fixes and enhancements in the SCL 11.7 release, see the SCL 11.7 release notes.
For information on the fixes and enhancements in the SCL 11.6 release, see the SCL 11.6 release notes.
For SCL supported OS & platform information, see the supported platforms page.

SCL Enhanced Logging Capability
For information on this new capability that will enable you to better troubleshoot licensing checkout problems, click here.

Pre-Installation

Installation, Configuration & Start-Up

Troubleshooting (SolvNet password might be required)

Documentation

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 11.8 ...

  • Alternately, on UNIX (only), you may determine your SCL version via the UNIX strings command:

    % strings /path/to/snpslmd | grep Build

    Note that these results give the Synopsys version, not the FLEXnet version. The FLEXnet version for SCL 11.8 is 11.12.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 SCL 11.8 from the list of available versions.
  • Click Download Here to download SCL by HTTPS.
  • After reading the legal page, Click on "Yes I agree to the above terms."
  • Click the download button next to the file names of the files you wish to download.
    (UNIX users must choose the "common" file and the OS platform file.)
  • Follow the browser prompts to select a destination download location.
    This directory must be a temporary directory and not the target installation directory.

To download the Synopsys Installer (UNIX 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.
  • Choose the latest product version (e.g., "3.1") from the list of available versions.
  • Click Download Here to download the Synopsys Installer by HTTPS.
  • After reading the legal page, Click on "Yes I agree to the above terms."
  • Click the download button next to the installer_v3.1.tar.Z file.
  • Follow the browser prompts to select a destination download location.

Note: SCL 11.8 requires Synopsys Installer version 3.1.

To install SCL
  • Type "installer" or "installer -gui" to start installation.
  • Enter the path to the temporary (source) directory.
  • 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.

Downloading 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: http://www.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.

Customizing the License Key File

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

#---------------------------------------------------------------
#Server Config: 0000052142
#---------------------------------------------------------------
SERVER hostname1 0128D07E321F 27020
VENDOR snpslmd /path/to/snpslmd
USE_SERVER
INCREMENT SSS snpslmd 1.0 10-dec-2014 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=03-oct-2005
INCREMENT hspice snpslmd 2013.12 10-dec-2014 8 VENDOR_STRING=^1+S \
SUPERSEDE ISSUED=06-dec-2013 ck=115 SN=RK:6719-0:733381:117716 \
START=03-oct-2005 AUTH={ snpslmd=( LK=6D8411D4365F7D1C39DB) \
avantd=( LK=CDE4E1546CD26F379ACB) }
INCREMENT metawaves snpslmd 2013.12 10-dec-2014 8 VENDOR_STRING=^1+S \
SUPERSEDE ISSUED=06-dec-2013 ck=39 SN=RK:6719-0:733381:117716 \
START=03-oct-2005 AUTH={ snpslmd=( LK=6D3441449638F796655F) \
avantd=( LK=DD44A164467F8C415694) }
#----------------------------------------------------------------

Note: Since snpslmd is a combined vendor daemon, SCL requires only a single VENDOR line ("VENDOR snpslmd").

For a full list of incorporated daemons, click here.

Before you can use the Synopsys license key file downloaded from Smartkeys, it must be customized for your site.
For both UNIX 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:

    • UNIX: /synopsys/scl/admin/license/synopsys.lic
    • Windows: C:\synopsys\scl\11.8\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 #

    • Blank lines must NOT be present in the key file as this may cause problems

    • Strip out all extraneous characters, such as > or >> symbols at the beginning of lines
      (sometimes added by email handlers)

  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.

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

    Mandatory

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

    Note: The hostid in the license key file (0128D07E321F in this example) must match your machine
    hostid 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 obtain a new license key file.
    (A "rehost form" may be required.)

    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

  5. 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:

    UNIX:
    VENDOR snpslmd /synopsys/scl/linux/bin/snpslmd

    Windows:
    VENDOR snpslmd C:\synopsys\scl\11.8\win32\bin\snpslmd.exe

    Optional

    Add the path to any license option file(s) at the end of the VENDOR line

    VENDOR snpslmd /synopsys/scl/linux/bin/snpslmd \
    /synopsys/scl/admin/options/synopsys.opt

  6. After modifications, your key file should look something like this (changes in bold):

    #---------------------------------------------------------------
    #Server Config: 0000052142
    #---------------------------------------------------------------
    SERVER aspen 0128D07E321F 27020
    VENDOR snpslmd /synopsys/scl/linux/bin/snpslmd
    # *** No other vendor daemons required ***
    USE_SERVER
    INCREMENT SSS snpslmd 1.0 10-dec-2014 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=03-oct-2005
    INCREMENT hspice snpslmd 2013.12 10-dec-2014 8 VENDOR_STRING=^1+S \
    SUPERSEDE ISSUED=06-dec-2013 ck=115 SN=RK:6719-0:733381:117716 \
    START=0c13-oct-2005 AUTH={ snpslmd=( LK=6D8411D4365F7D1C39DB) \
    avantd=( LK=CDE4E1546CD26F379ACB) }
    INCREMENT metawaves snpslmd 2013.12 10-dec-2014 8 VENDOR_STRING=^1+S \
    SUPERSEDE ISSUED=06-dec-2013 ck=39 SN=RK:6719-0:733381:117716 \
    START=03-oct-2005 AUTH={ snpslmd=( LK=6D3441449638F796655F) \
    avantd=( LK=DD44A164467F8C415694) }
    #---------------------------------------------------------

  7. Save your change.

    You are now ready to start the license server.

Starting 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.

Choose your license server OS:

Starting a License Server under UNIX

    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 licensing daemon, use the following command syntax:
    lmgrd -c license_key file_name -l debug_log_filename

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

    % scl_root/linux/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.12.1 or higher has started <--FLEXnet version
    • SCL version SCL 11.8 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 UNIX license server will now be able to serve any clients on the network, regardless of the
    client operating system (UNIX, Linux, Windows).

  4. For each client, set a licensings environment variable (see next section). If there are
    any problems using the tools see the troubleshooting section of this document.

  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 > All Programs > Synopsys > SCL 11.8 > lmtools.exe
  • 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 Windows 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.
      Note: If the hostid information is incorrect, you must not modify the key file hostid. (If a Synopsys mistake was made, contact sales to obtain a new key file for the correct hostid.)

  3. Click Services/License File.
    Make sure Configure using Services is selected.
  4. Click Configure Services.

    1. Under Service Name, type in an arbitrary service name (for example, "Synopsys Licensing").

    2. Next to "Path to the lmgrd.exe file," click Browse and browse to lmgrd.exe.
      For example, browse to C:\synopsys\scl\11.8\win32\bin\lmgrd.exe or C:\synopsys\scl\11.8\win32\bin\lmgrd.exe.
    3. Next to "Path to the license file," click Browse and browse to the Synopsys key file.
      For example, browse to C:\synopsys\scl\11.8\admin\license\synopsys.lic.
    4. Next to "Debug Log File," type the path to create a debug.log file.
      (This file need not exist; it will be created for you.)
      For example, type C:\synopsys\scl 11.8\admin\logs\debug.log.

    5. 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.

    6. 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:

    1. Click Configure Services.

    2. Click View Log to view the debug.log file.

      Check the time-stamped entries to verify that

      • lmgrd (FLEXnet Licensing) v11.12.1 has started <--FLEXnet version
      • snpslmd (SCL) v 11.8 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.12.1.0 build 146690 i86_lsb) started on my_server
    17:09:39 (lmgrd) Copyright (c) 1988-2014 Flexera ...
    ...
    ...
    17:09:39 (lmgrd) License file(s): C:\synopsys\scl\11.8\admin\logs\synopsys.lic
    17:09:39 (lmgrd) lmgrd tcp-port 27020
    17:09:39 (lmgrd) Starting vendor daemons ...
    17:09:40 (lmgrd) Started snpslmd (pid 836)
    17:09:40 (snpslmd)FLEXnet Licensing version v11.12.1 build 146690 x86_lsb
    17:09:40 (snpslmd)Synopsys Corporate Licensing (SCL) Release: version scl 11.8
    17:09:42 (snpslmd) Server started on my_server for:
    17:09:42 (snpslmd) hspice hspice_gui metawaves
    17:09:42 (snpslmd) DC-Expert DC-SDF-Interface DC-Ultra-Features
    17:09:42 (snpslmd) DC-Ultra-Opt Design-Budgeting Design-Compiler
    17:09:42 (snpslmd) Design-Vision DesignWare DesignWare-VERA
    17:09:42 (snpslmd) Designware-Basic HDL HDL-Compiler
    17:09:42 (snpslmd) PrimeTime SynLib-Eval Test-Compiler
    17:09:42 (lmgrd) snpslmd using TCP-port 3789
    17:09:42 (snpslmd) Serving features for the following vendor names:
    snpslmd ACAD adalmd anagram arcd archprod avantd CADABRA chrysalisd
    cowared EPIC eved everest extremed hscd innologd ISE-TCADd knights
    la_dmon leda magma metasoftd mwflexd nassd nsysnvs numeritchd pdld
    riod saber_dmn sandwork sclmgrd sigmacd slat snslmgrd snpsOEM1 snpsOEM2
    snpsOEM3 snpsOEM4 ssilmd synforad synopsysd synplctyd TAVEREN TE_CATS
    tmald vastlmd vcsd

  7. Your SCL license server will now be able to serve any clients on the network,
    regardless of the client operating system.

  8. For each client, set a licensing environment variable (see next section). If there are
    any problems using the tools see the troubleshooting section of this document.

Setting 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

Setting up the User Environment under UNIX

Set SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE.

  • 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]

    setenv SNPSLMD_LICENSE_FILE 27020@aspen
    [where "27020" and "aspen" are the port and hostname we used in our example]

    setenv SNPSLMD_LICENSE_FILE /synopsys/scl/11.8/license/synopsys.lic
    [path syntax]

    setenv SNPSLMD_LICENSE_FILE 27020@aspen:27010@vail
    [separate individual license file references using a colon]

  • Bourne, Korn, or Bash shells
    Add to Synopsys source file or bashrc, .kshrc, or .profile:

    SNPSLMD_LICENSE_FILE=27020@aspen
    export SNPSLMD_LICENSE_FILE

    Type of Key File Variable Name UNIX Variable Value
    Network License (floating) SNPSLMD_LICENSE_FILE or
    LM_LICENSE_FILE
    27020@my_server
    Multiple License Servers SNPSLMD_LICENSE_FILE or
    LM_LICENSE_FILE
    27020@aspen:27010@vail
    (Delimiter is a colon)

Setting up the User Environment under Windows

  1. Windows OS: Click Start > Settings > Control Panel > System > Advanced > Environment Variables
  2. Under System Variables, click New (to create a new variable) or Edit (to edit and existing variable).
  3. Under Variable Name, enter SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE
  4. Under Variable Value, enter the correct port@host information.

    Example:

    Type of Key File Variable Name Windows Variable Value
    Network (floating) SNPSLMD_LICENSE_FILE or
    LM_LICENSE_FILE
    27020@My_Windows_Server
    Counted Nodelocked SNPSLMD_LICENSE_FILE or
    LM_LICENSE_FILE
    27020@My_Windows_Server
    Uncounted Nodelocked
    (SCL not required)
    SNPSLMD_LICENSE_FILE or
    LM_LICENSE_FILE
    C:\synopsys\scl\11.8\admin\license\snps.lic
    Multiple License Servers SNPSLMD_LICENSE_FILE or
    LM_LICENSE_FILE
    28000@jflores-pc;27020@aspen
    (Delimiter is a semicolon)