Synopsys Licensing QuickStart Guide

June 2007: SCL 10.9.2 is released.
For information on the fixes and enhancements for this release, see the release notes.

SCL 10.9.1d or later is now required to run all Synopsys products. SCL 10.9.2 is highly recommended.

Important:

Starting with the A-2007.09 release, Synopsys tools  will no longer include support for legacy daemons.  This means that these tools will no longer support  legacy-format licenses or legacy daemons.  It also means that the user environment will no longer support legacy licensing variables.  For details on these changes, click here. 

With SCL 10.x, Synopsys has introduced Synopsys Secure Server (SSS) technology. Therefore, it is important that any cvd license files received from Synopsys be verified by running the SCL sssverify tool. A failure to verify the license file could lead to license denials. If you get any sssverify errors, or any SSS errors in the license server log file, there will be license checkout request denials until the problem is resolved.

See the Synopsys License File Verification Checklist for details on how to run sssverify as well as troubleshooting information. If you need assistance on SSS/sssverify issues, or any other licensing issues, open a support case at https://solvnet.synopsys.com/EnterACall

If you have not yet upgraded to SCL 10.9.2, please do the following ASAP:

1. Make sure your license servers meet the hardware and configuration requirements.

2. Deploy SCL version 10.9.2 or higher into your production environment.

If your site is on support ("on maintenance") you may download the software via Electronic Software Transfer.

• To download Synopsys Common Licensing 10.9.2, click here.
  
• To determine your current Synopsys Common Licensing version, see instructions.
  
• To see the fixes in SCL 10.9.2, see the SCL 10.9.2 Release Notes.

In this Licensing QuickStart Guide you'll find SCL download instructions, key file retrieval information, and setup instructions. The following topics are covered:

Pre-Installation

• Supported SCL Platforms by Operating System & Platform Keyword
• Determining the License Server Hostid
• Ordering a USB dongle for the Microsoft Windows OS
• Determining Your Current SCL Version

Installation, Configuration & Start-Up

1. Downloading & Installing SCL (lmgrd, snpslmd)
2. Downloading Your Site's License Key File
3. Customizing the License Key File
4. Starting the License Server
5. Setting Up the User Environment to Access the Key File

Troubleshooting (SolvNet password may be required)

• Resolving SSS / sssverify errors
• lmgrd Error Message: "Failed to open the TCP port number in the license"
• snpslmd Error Message: lmgrd Refused Vendor Name List
• SCL 10.9.x crashes with errors in the debug logfile
• Tools Based on Legacy Daemons Fail to Start
• Dongle Setup & Troubleshooting (Windows)
• Starting HSPICE, AvanWaves or CosmosScope Brings up License Finder Window
• Why lmstat Does Not Work on Multiple License Files

Migration Information

• Recommended Hardware & Configuration Checklist
• Supported Platforms by Operating System & Platform Keyword

Documentation (PDF or txt format)

• SCL 10.9.2 Installation Readme (Web or ftp installers)
• SCL 10.9.2 Release Notes
• SCL 10.9.2 Administration Guide
• Macrovision FLEXnet User Manual

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_10.9.2 ...
  

• 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 10.9.2 is 10.8.5.0.

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,

Note: SCL requires that you also download the Installer. Use the above procedure to download the installer, choosing "Synopsys Installer" as the product. For more details on installing SCL (including how to download by FTP), see the Download & Installation Procedure section of the SCL 10.9.2 Installation Readme file.

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 807E321F 27000
VENDOR snpslmd /path/to/snpslmd
USE_SERVER
INCREMENT SSS snpslmd 1.0 20-dec-2008 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 2007.09 20-dec-2008 8 VENDOR_STRING=^1+S \
   SUPERSEDE ISSUED=20-nov-2007 ck=115 SN=RK:6719-0:733381:117716 \
   START=03-oct-2005 AUTH={ snpslmd=( LK=6D8411D4365F7D1C39DB) \
   avantd=( LK=CDE4E1546CD26F379ACB) }
INCREMENT metawaves snpslmd 2007.09 20-dec-2008 8 VENDOR_STRING=^1+S \
   SUPERSEDE ISSUED=20-nov-2007 ck=39 SN=RK:6719-0:733381:117716 \
   START=03-oct-2005 AUTH={ snpslmd=( LK=6D3441449638F796655F) \
   avantd=( LK=DD44A164467F8C415694) }
#----------------------------------------------------------------

Note:
SCL 10.9.2 supports only a single "VENDOR snpslmd" line.
This daemon supports legacy tools based on avantd, tmald, nassd and various other SCL-incorporated vendor daemons.

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:  /usr/synopsys/scl/admin/license/synopsys.lic
   • Windows:  C:\synopsys\scl10.9.2\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.
     With SCL 10.9 & above, they are not required or 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 (807E321F 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 (default is 27000) to any available TCP port between 1024 and 64000.

   Example:

   SERVER aspen 807E321F 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 /usr/synopsys/scl/sparc64/bin/snpslmd
   

   Windows:
   VENDOR snpslmd C:\synopsys\scl10.9.2\msvc70\bin\snpslmd.exe
   

   Optional

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

   VENDOR snpslmd /usr/synopsys/scl/sparc64/bin/snpslmd \
         /usr/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 807E321F 27020
   VENDOR snpslmd /usr/synopsys/scl/sparc64/bin/snpslmd
   # *** No other vendor daemons required ***
   USE_SERVER
   INCREMENT SSS snpslmd 1.0 20-dec-2008 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 2007.09 20-dec-2008 8 VENDOR_STRING=^1+S \
      SUPERSEDE ISSUED=20-nov-2007 ck=115 SN=RK:6719-0:733381:117716 \
      START=03-oct-2005 AUTH={ snpslmd=( LK=6D8411D4365F7D1C39DB) \
      avantd=( LK=CDE4E1546CD26F379ACB) }
   INCREMENT metawaves snpslmd 2007.09 20-dec-2008 8 VENDOR_STRING=^1+S \
      SUPERSEDE ISSUED=20-nov-2007 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

Choose your license server OS:

• UNIX
• Windows

Starting a License Server under UNIX

1. Since SCL 10.9.2 incorporates many vendor daemons, all incorporated daemons
   (snpslmd, avantd, tmald, etc.) must be shut down before you will be able to
   start SCL. Click here for a list of incorporated daemons that will need to be shut down.

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

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

2. 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/sparc64/bin/lmgrd -c scl_root/admin/license/synopsys.lic \
      -l scl_root/admin/logs/snps.debug.log

3. 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) v10.8.3.1 or 10.8.5.0 or later has started <--FLEXnet version
   • snpslmd (SCL) v10.9.1d or 10.9.2 or later 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).

4. Your UNIX license server will now be able to serve any clients on the network, regardless of the
   client operating system (UNIX, Linux, Windows).

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

6. 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 > Programs > Synopsys > SCL10.9.2 > launch 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

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 may 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\scl10.9.2\msvc70\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\scl10.9.2\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\scl10.9.2\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 10.9.2 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) v10.8.3.1 or later has started <--FLEXnet version
      • snpslmd (SCL) v10.9.1d or 10.9.2 or later 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:
   

   7:09:39 (lmgrd) Done rereading
   17:09:39 (lmgrd) FLEXnet Licensing (v10.8.5.0 build 31891) started on my_server
   17:09:39 (lmgrd) Copyright (c) 1988-2006 Macrovision ...
   ...
   ...
   17:09:39 (lmgrd) License file(s): C:\synopsys\scl10.9.2\admin\logs\synopsys.lic
   17:09:39 (lmgrd) lmgrd tcp-port 27000
   17:09:39 (lmgrd) Starting vendor daemons ...
   17:09:40 (lmgrd) Started snpslmd (pid 836)
   17:09:40 (snpslmd)FLEXnet Licensing version v10.8.5.0 build 31891
   17:09:40 (snpslmd)Synopsys Corporate Licensing (SCL) Release: version SCL_10.9.2
   17:09:42 (snpslmd) Server started on my_server for: APHPO
   17:09:42 (snpslmd) APTIME Apollo Astro
   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 CADABRA EPIC ISE-TCADd TE_CATS adalmd anagram
   avantd chrysalisd everest hscd innologd la_dmon leda metasoftd
   numeritchd saber_dmn slat ssilmd synopsysd tmald vcsd
   
7. Your SCL license server will now be able to serve any clients on the network,
   regardless of the client operating system (UNIX, Linux, Windows).

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

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 

Important:      
       Legacy variables such as AVANTD_LICENSE_FILE, NASSD_LICENSE_FILE, TMALD_LICENSE_FILE, etc.,
      are not supported for tool releases starting with 2007.09.

Environment Variable Set-Up Examples:

• UNIX
  
• Windows

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 27000@oak
  [port@host syntax--where 27000 is the TCP port specified in the license file and"oak" 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 /usr/synopsys/scl/license/synopsys.lic
  [path syntax]

  setenv SNPSLMD_LICENSE_FILE 27000@oak:27020@aspen
  [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=27000@oak
  export SNPSLMD_LICENSE_FILE

  Type of Key File Variable Name Variable Value (UNIX OS) Network License (floating) SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE 27000@my_server Multiple Key Files (separate by colons) SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE 27000@oak:27020@aspen

Setting up the User Environment under Windows

1. Windows 2000 or higher: Click Start > Settings > Control Panel > 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 Variable Value (Windows OS) Network License (floating) SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE 27000@My_Windows_Server Nodelocked License (dongle or ethernet address--counted) SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE 27000@My_Windows_Server Nodelocked License (dongle--legacy, uncounted) LM_LICENSE_FILE C:\synopsys\scl10.9.2\admin\license\dongle.lic Multiple Key Files (separate by semicolons) SNPSLMD_LICENSE_FILE or LM_LICENSE_FILE 27000@jflores-pc;27020@aspen