A Guide to Using
CMG Licensing By Computer Modelling Group Ltd.
This publication and the application described in it are furnished under license exclusively to the licensee, for internal use only, and are subject to a confidentiality agreement. They may be used only in accordance with the terms and conditions of that agreement. All rights reserved. No part of this publication may be reproduced or transmitted in any form or by any means, electronic, mechanical, or otherwise, including photocopying, recording, or by any information storage/retrieval system, to any party other than the licensee, without the written permission of Computer Modelling Group. The information in this publication is believed to be accurate in all respects. However, Computer Modelling Group makes no warranty as to accuracy or suitability, and does not assume responsibility for any consequences resulting from the use thereof. The information contained herein is subject to change without notice.
Copyright 1987-2012 Computer Modelling Group Ltd. All rights reserved.
The license management portion of this program is based on: Reprise License Manager (RLM) Copyright 2006-2012, Reprise Software, Inc. All rights reserved
Builder, CMG, and Computer Modelling Group are registered trademarks of Computer Modelling Group Ltd. All other trademarks are the property of their respective owners. Computer Modelling Group Ltd. Office #150, 3553 - 31 Street N.W. Calgary, Alberta Canada T2L 2K7
Tel: (403) 531-1300
Page 2
Fax: (403) 289-8502
E-mail:
[email protected]
A Guide to Using CMG Licensing
Contents
Overview ................................................................................................................................... 4 About This Document .............................................................................................................................. 4 About the Reprise License Manager......................................................................................................... 4 Technical Support ..................................................................................................................................... 5 An Overview of the Installation and Licensing Process........................................................ 5 Types of Licensing ................................................................................................................................... 5 Standalone ............................................................................................................................................................5 Network................................................................................................................................................................5
Installation and Authorization Process ..................................................................................................... 5 Setting Up a Standalone Installation ....................................................................................................................6 Setting Up a Network Installation ........................................................................................................................6
Generating a HostID and Sending it to CMG .......................................................................... 6 Generating a HostID during Installation................................................................................................... 7 Windows ..............................................................................................................................................................7 Linux and AIX .....................................................................................................................................................7
Generating a HostID after Installation...................................................................................................... 7 Windows ..............................................................................................................................................................7 Linux and AIX .....................................................................................................................................................8
Other Methods of Generating HostID Information .................................................................................. 8 rlmhostid Utility ...................................................................................................................................................8 Direct Method ......................................................................................................................................................8
Sending the HostID Information to CMG ................................................................................................ 8 Starting the License Server ..................................................................................................... 8 Starting the License Server on Windows.................................................................................................. 8 Starting the License Server on Linux and AIX ........................................................................................ 9 Installing Your License File ..................................................................................................... 9 Installing Your License File Using the CMG License Utility .................................................................. 9 Installing Your License File Using the Reprise Server Administration Interface .................................... 9 Checking License Status ........................................................................................................11 Checking License Status Using the CMG License Utility ..................................................................... 11 Checking License Status Using the Reprise License Server Administration Page ................................ 12 Going Beyond the Basics .......................................................................................................14 Roaming ................................................................................................................................................. 14 Checking Out Licenses ...................................................................................................................................... 14 Advanced Check Out ......................................................................................................................................... 15 Using Checked-Out Licenses ............................................................................................................................. 16 A Guide to Using CMG Licensing
Page 3
Checking In Licenses ......................................................................................................................................... 16 Additional Information About Roaming ............................................................................................................ 17
Getting Diagnostic Information .............................................................................................................. 18 Configuring RLM in a Firewall Environment ........................................................................................ 18 Configuring the RLM and ISV Options Files .........................................................................19 Common RLM Options .......................................................................................................................... 21 Common ISV Options ............................................................................................................................ 22 Configuring License Timeout ............................................................................................................................ 22
Enabling the Report Log......................................................................................................................... 23 Rotating the Report Log ..................................................................................................................................... 24 Analyzing the Report Log .................................................................................................................................. 24 Third-Party Analysis Tools ................................................................................................................................ 25
Restricting Access to Licenses ............................................................................................................... 25 Using a Hardware Key (Dongle) .............................................................................................26 Requirements for Dongle-based Licensing ............................................................................................ 26 Installing the Dongle Drivers ................................................................................................................. 27 Using Windows to Automatically Install Drivers .............................................................................................. 27 Installing the Drivers Using the Installation Program ........................................................................................ 28
Reprise Utilities .......................................................................................................................30 rlmdown ............................................................................................................................................................. 31 rlmhostid ............................................................................................................................................................ 31 rlmnewlog .......................................................................................................................................................... 31 rlmremove .......................................................................................................................................................... 31 rlmreread ............................................................................................................................................................ 31 rlmstat ................................................................................................................................................................ 32 rlmswitch............................................................................................................................................................ 32
How CMG Applications Are Licensed....................................................................................32
Page 4
A Guide to Using CMG Licensing
Overview
About This Document This manual describes the CMG licensing, the steps necessary to get your software working, and how to troubleshoot licensing problems. To use CMG’s software, you will need to have valid licensing in place. This means the licensing system needs to be installed and running with valid authorization codes tied to your computer. Later sections will go in depth on the following: •
Installing the software with the licensing.
•
Determining the HostID information.
•
Receiving and installing a License File.
•
Checking the licensing status.
•
Going beyond basic licensing.
About the Reprise License Manager CMG uses the Reprise License Manager (RLM) from Reprise Software. Additional information about RLM is available on their website at www.reprisesoftware.com. In particular, the RLM End-User Manual (http://www.reprisesoftware.com/RLM_Enduser.html) and the End-User Frequently-Asked-Questions (http://www.reprisesoftware.com/support/faq.php) should be noted. All support issues should go directly to CMG technical support. Reprise Software does not provide end user support.
A Guide to Using CMG Licensing
Page 5
Technical Support Clients seeking technical support from CMG should first contact our head office in Calgary via phone (North America: 403-531-1300) or email (
[email protected]). Support is available during normal Canadian business hours, Mountain Time. Additional support is available from our world-wide staff of Sales Support Engineers: •
Page 6
Houston, USA ..................................................... 281-872-8500
•
London, UK .................................................. (44-1491) 821111
•
Caracas, Venezuela ..................................... (58-212) 993-3091
•
Rio de Janeiro, Brazil .................................... (55-21) 25469897
•
Dubai, UAE ................................................... (971-4) 434-5190
A Guide to Using CMG Licensing
An Overview of the Installation and Licensing Process
There are a number of steps to be followed when setting up your CMG software for the first time. First, install the software on your computer. As a part of this step, you will be prompted to generate a unique fingerprint for your computer (the “HostID”). You need to send this HostID to us so that we can generate your license file. After we have generated your license file, you need to install it on your computer. After this, you will be able to run your CMG software. Depending on your license configuration you may not need to perform all these steps for every computer you are installing on.
Types of Licensing CMG software supports two different types of licensing: Standalone licensing, where the software will only work on a single designated computer, and Network licensing, where the authorization codes are on a designated server and multiple clients can use that server’s licenses. The type of licensing you use is determined by how you have licensed the software from CMG.
Standalone Standalone licensing restricts usage of CMG products to the computer the License File is installed on. With Standalone licensing, you are allowed to run multiple simultaneous copies of CMG’s graphical applications on your computer. CMG simulators are limited to a fixed number of simultaneous copies as per your license agreement.
Network Network licensing allows multiple computers to use the software over a network. One computer is the Network License Server and all other computers are Network License Clients.
A Guide to Using CMG Licensing
Page 7
The Network License Server is the computer where the RLM licensing server is running and the License File is installed. Applications on the Network Licensing Client pull licenses from this computer when they need them.
Installation and Authorization Process Note: CMG does not allow license servers to run on Virtual Machines such as Windows Virtual PC or VMware.
Setting Up a Standalone Installation Step 1: Install the Software. For more information on how to install CMG software, see A Guide to Installing CMG Software on Windows or A Guide to Installing CMG Software on Linux and AIX Workstations. Step 2: Generate a HostID and email it to CMG. See Generating a HostID and Sending it to CMG on page 6 in this document for more information. Step 3: Install the License File. See Installing Your License File Using the Reprise Server Administration Interface on page 9 in this document for more information.
Setting Up a Network Installation Setting up a Network Installation requires the configuration of the Network License Server and configuration of each Network License Client Configuring the Network License Server The steps involved to setup up a Network Installation are similar to those for setting up a Standalone Installation. Step 1: Install the Software. For more information on how to install CMG software, see A Guide to Installing CMG Software on Windows or A Guide to Installing CMG Software on Linux and AIX Workstations. Step 2: Generate a HostID and email it to CMG. See Generating a HostID and Sending it to CMG on page 6 in this document for more information. Step 3: Install the License file. See Installing Your License File Using the Reprise Server Administration Interface on page 9 in this document for more information. Configuration of the Network License Clients Configuring a Network License Client requires only that the CMG software be installed on the client computer. During installation, you will be prompted for the name of the Network License Server. See A Guide to Installing CMG Software on Windows or A Guide to Installing CMG Software on Linux and AIX Workstations for more information.
Page 8
A Guide to Using CMG Licensing
Generating a HostID and Sending it to CMG
To use the CMG software you will require a License File that is locked to your system. This file is locked to a combination of unique characteristics of your computer called the HostID. For example, the HostID may include your computer’s Ethernet MAC address. You will need to send us the HostID information for us to generate your License File. You will not be able to run CMG software until we have this information and have issued you the file. The HostID information can be generated automatically during installation and also at any time afterward.
Generating a HostID during Installation Windows When the installation is almost complete, you will be asked if you want to generate your HostID information. Fill in the required contact information and then save it to your hard disk.
Linux and AIX When the installation is almost complete, you will be asked if you want to generate your HostID information. If you do so, it will automatically be saved to the file /hostid.info. You should edit this file to include your contact information.
Generating a HostID after Installation It may sometimes be necessary to generate HostID information after you have installed the software. There are custom utilities provided by both CMG and Reprise that allow you to do that.
A Guide to Using CMG Licensing
Page 9
Windows The recommended way to check the HostID information on Windows is to use the CMG License Utility. The CMG License Utility may be started from the Start menu. Press the “Get HostID…” button to bring up the following dialog box:
Enter your information into the dialog. The information you enter does not affect the actual HostID that is generated. It just helps ensure that we can find your order in our system. You may save this information to a text file to email to CMG for generation of your authorization codes. See Sending the HostID Information to CMG on page 8.
Linux and AIX The utility cmghostid.sh will generate the HostID information and print it to standard output. You can redirect the output to a file and send it to CMG. In a command prompt change to the $CMG_HOME directory and run the command rlmsecure/cmghostid.sh.
Other Methods of Generating HostID Information rlmhostid Utility RLM supplies a HostID utility (rlmhostid) which can be found in the RLMSecure directory. It is a console application, so it must be used from within Page 10
A Guide to Using CMG Licensing
the Windows Command Interpreter (also known as the command prompt or DOS shell). Basic usage is rlmhostid
This will yield the HostID (the “32-bit hard drive number”) of the computer with this output: rlmhostid v9.0 Copyright (C) 2006-2008, Reprise Software, Inc. All rights reserved Hostid of this machine: d8ffec1d
For complete instructions on how to use rlmhostid, check the section Going Beyond the Basics: Reprise utilities. The rlmhostid utility is available for AIX and Linux as well. You can find them in the $CMG_HOME/rlmsecure directory.
Direct Method The values that the CMG HostID utility and rlmhostid report are not encrypted and you may therefore simply report the Ethernet MAC address, IP address, hostname and hard disk ID to us if you have access to that information. This should be a last resort as we would rather have the information as provided by one of our utilities – this guarantees that the licensing is looking at the correct values.
Sending the HostID Information to CMG Once you have your HostID information, you need to send it to us. There are two ways of doing this. The preferred method is to send it by email to
[email protected]. Alternatively, you can fax it to us at 403-282-6495. Once we have received this information we will use it to generate the License File you are entitled to and send it back. We try our best to have your codes sent to you as soon as possible, but due to the volume of requests we receive, it could take up to two business days.
A Guide to Using CMG Licensing
Page 11
Starting the License Server
The License Server runs as a Windows Service on Windows and as a daemon on Linux and AIX.
Starting the License Server on Windows By default, the CMGL RLM Service is set to start as an Automatic startup service. If for some reason you need to change this or restart the service, you may do this via the Services Control Panel applet which is located in the Administrative Tools area.
Starting the License Server on Linux and AIX The CMGL RLM Service on Linux and AIX runs as a daemon process. You may start this process using the RestartRLM.sh script located in the CMG_HOME directory. Instructions on how to setup the Linux or AIX daemon so that it starts automatically can be found in the RLM End-user’s Manual.
Page 12
A Guide to Using CMG Licensing
Installing Your License File
There are two ways you can install your License File. The recommended method is to use the CMG License Utility. This application consolidates most of the CMG-specific licensing functions into a single interface and ensures that your License File is loaded properly. You may also use the Reprise Server Administration Interface to install your License File.
Installing Your License File Using the CMG License Utility The CMG License Utility runs only on Windows. To install a License File on Linux or AIX see Installing Your License File Using the Reprise Server Administration Interface on page 9. To install your License File using the CMG License Utility, follow these steps.
A Guide to Using CMG Licensing
1.
If you received your License File via email, save it to a file on disk.
2.
Start the CMG License Utility from the Start menu.
Page 13
3.
Press the “Load License File…” button and browse to the License File on your disk. Press OK. The CMG License Utility will scan the file for correctness and load it into the RLM License Server.
Installing Your License File Using the Reprise Server Administration Interface You may also install your License File through the Reprise Server Administration Interface. Follow these steps on the license server computer. 1. Copy the file to the \RLMSecure directory. 2. Rename it “cmgl.lic” if it does not already have that name. If you have Windows Explorer set up to hide file extensions, the file may be renamed to cmgl.lic.txt instead of cmgl.lic. If this is the case, open a command prompt and rename the file from there. 3. 4.
Open an Internet Web browser (for example, Internet Explorer, Mozilla Firefox or Opera). In the Address/URL bar, enter http://localhost:5054/. This accesses the Reprise License Server Administration page for the local computer.
Previous versions used port 9000. If the localhost address does not work, try http://127.0.0.1. If this does not work, ensure the CMGL RLM Service is running. 5.
Page 14
Once the Reprise License Server Administration page is displayed, click on the Reread/Restart Servers link. The Reread/Restart Servers page will be displayed. A Guide to Using CMG Licensing
6.
Select cmgl in the ISV field (as shown in the above figure) and then click REREAD/RESTART.
You should now be able to use any CMG application that you are entitled to.
A Guide to Using CMG Licensing
Page 15
Checking License Status
Checking License Status Using the CMG License Utility The CMG License Utility allows you to see what licenses are installed on the license server you are connected to. Licenses are grouped by server and by product. Some products (such as the simulators) may have multiple types of licenses available.
The computer you are getting licenses from is shown in the first line of the grid. Standalone configurations will show either localhost or 127.0.0.1. If the RLM Service is running on your computer, this is shown as well. The CMG License Utility does not show expired licenses, nor does it account for licenses that have been checked out. CMG applications require twenty keys in the authorization codes file per use. This is indicated by the “count” in the Number of Licenses column. Page 16
A Guide to Using CMG Licensing
Checking License Status Using the Reprise License Server Administration Page You can get further information about the licenses available by using the Reprise License Server Administration Page. This page is accessed via your Internet Web browser. You do not need to be connected to the Internet to access the Reprise License Server Administration Page. 1. 2.
Open an Internet Web browser (for example, Internet Explorer, Mozilla Firefox or Opera). In the Address/URL bar, enter http://localhost:5054/. This accesses the Reprise License Server Administration page for the local computer.
Previous versions used port 9000 by default. If you have changed the port number the RLM Administration Web Service is listening on, use that number instead of the default.
A Guide to Using CMG Licensing
3.
Click the Status button. This will take you to the Status pane.
4.
If your CMG software has been installed correctly with proper authorization codes, there will be a CMG row in the table of ISV Servers. Click on the Server Status button in the cmgl row. This takes you to the ISV cmgl status page.
Page 17
Table entries are as follows: Product: The name of the license. Pool: Each pool has a unique number. Multiple entries for similar licenses (for example if they differ only in the expiration date) may be collapsed into a single pool by the RLM service. Ver: The version of the software that can be run with this license. In this case GEM 2099.99 or earlier can be run with the current licenses. Count: This is the number of keys available for each license. Soft lim: CMG does not use soft limits on licensing. This field can be ignored. in use: The number of license keys currently in use. The Show License Usage button will tell you who is using these licenses. Remember, CMG applications use licenses in multiples of twenty. res: The number of licenses reserved. Licenses are not normally reserved, but end-users can set reservations by modifying their ISV Options. hostid: If this field is blank, it indicates a network license that can be used by any client computer. If the field has a HostID in it, it is a stand-alone license that can only be used by the computer with the matching HostID. timeout: The TIMEOUT value for the license after which an idle license is checked back into the pool freeing it up for other users. share: The sharing criteria for the license. This allows multiple instances of an application to share a license. Currently only Builder, Results, CMOST Studio and WinProp use sharing. hold: The hold time for the license. CMG does not allow license holding so this field can be ignored. transactions: The number of times that this license has been used to run an application.
Page 18
A Guide to Using CMG Licensing
Show License Usage: Click to show any current users of the license. For more information on using the Reprise License Server Administration page, see http://www.reprisesoftware.com/RLM_Enduser.html. You may also access the Reprise License Server Administration page from another computer. Just use http://computername: 5054 (where computername is the name of the license server computer) as the address in your Web browser. If you have changed the port number the RLM Web server is listening on, use that number instead of 5054. Previous versions used port 9000.
A Guide to Using CMG Licensing
Page 19
Going Beyond the Basics
Roaming Sometimes you want to use the CMG software when traveling. If your licenses normally reside on a Network Server you will need use the roaming feature. This allows you to use a license when disconnected from your network for days or weeks at a time. To use roaming, the computer must have the CMG software installed as Network Client. It should initially be on a network with an active CMG license server. The network server must have roaming enabled. If the server has an rlm_roam license then roaming is enabled.
Checking Out Licenses To use a roaming license you must check it out. This allows you to use the software on the client machine for the amount of time you have checked it out, even if you disconnect from the network after the checkout. To check out licenses, do the following:
Page 20
1.
From the menu bar, select Common Tasks and then Roaming Checkout…. This brings up the Check Out Licenses For Roaming dialog box.
2.
Select the products you want to check out and click OK. The software will be checked out from the specified License Server for the specified number of days.
A Guide to Using CMG Licensing
The Check Out Licenses For Roaming dialog box has several components: LicenseServer: Allows you to select which license server to check licenses out from. By default, this is your normal license server. Maximum Days to Roam: The number of days to check the license out for. At the end of this period your license will be automatically returned to the license server. You can check out a roaming license for one to thirty days. Note that checking a license out for one day means that you will have it until midnight of the following day (i.e. if you check a license out on Tuesday, it will remain checked out until the end of Wednesday). Check boxes for individual CMG products: If you want to check out GEM, check the GEM box. If you want to check out Builder and Results, you’ll need to check the Builder box and the Results box. GEM, IMEX and STARS have additional options for checking out, which will be explained below. Select All For Check Out: This checks all of the boxes. Uncheck All: This removes checks from all of the boxes. Cancel: Closes the dialog without checking out any licenses for roaming. OK: Closes the dialog and checks out any selected software for roaming.
Advanced Check Out The vast majority of our users can use roaming as it is described above. Selecting a simulator to check out will also check out all the optional components that the simulator license requires. If you require finer control over checkouts, the following diagram shows the full list of options:
1.
This section shows which simulator license to check out. Most clients will only have one kind of simulator license, but multiples are possible. A normal simulator license (for example, GEM, IMEX and STARS) allows unlimited gridblocks and can be used to run that one simulator only. A gridblock-limited license (for example, GEM 100K, IMEX 50K, STARS 10K) allows only the specified number of gridblocks. Solver licenses (SOLVE STARS, SOLVE GEM/IMEX, SOLVE University, SOLVE CSB) can work with multiple simulators. Some have gridblock limits (SOLVE University: 10,000 Gridblocks, SOLVE CSB: 1000 Gridblocks). Pick the license you want to use and it will be checked out.
A Guide to Using CMG Licensing
Page 21
2.
This section shows the options for a Parallel license. Checking the Parallel box will also check out one parallel token from the server, allowing the local machine to run up to four threads. You can choose either a simulator parallel license or a Solver parallel license (which will work with all three simulators). You should only disable an option if you are absolutely certain you won’t need it.
3.
This section shows the various optional licenses available with the simulator. All available options are enabled by default and will be checked out unless you uncheck them first. Dynamic Gridding is shared by all three simulators, so if you enable or disable it for one simulator, you will enable or disable it for all simulators.
Using Checked-Out Licenses Once your licenses are checked out, you should be able to use the CMG software normally – even when you are disconnected from your normal network. No additional steps are required.
Checking In Licenses Licenses can be checked in two ways. If the checked-out licenses reach the end of their checkout period, they will be automatically renewed on the license server. You can also check them in sooner this way:
Page 22
1.
Make sure you are connected to the network with the license server. You need to be able to communicate with the license server to check licenses back in.
2.
From the menu bar, select Common Tasks and then Roaming Checkin…. This brings up the Check In Licenses From Roaming dialog box.
3.
Select the products you want to check in and click OK.
A Guide to Using CMG Licensing
Only licenses that have been checked out will appear in the list. All licenses will automatically have their boxes checked. If you only want to check in some licenses, you will need to select which licenses should be checked in and which ones should be ignored.
Additional Information About Roaming A maximum of one license can be checked out (and used) at a time – even if your computer is capable of running multiple jobs simultaneously, you cannot run the same simulator twice with a checked-out license. This is due to limitations in the third-party licensing. You can use the Check Out Licenses For Roaming dialog box multiple times though. If you use it twice for the same CMG product it will simply renew the existing checkout. You might want to do this to extend the amount of time you have your checkout for. If you find you cannot check your licenses back in normally, you can attempt to force them back in. This will result in all products being checked back in. To use this feature, click the Advanced menu and select Force Roaming Check in.
Getting Diagnostic Information On occasion you may have trouble accessing your CMG licenses. The CMG License Utility can provide you with diagnostic information to help troubleshoot this situation. You may access the diagnostic information as follows: 1.
Start the CMG License Utility.
2.
From the menu bar, select Advanced and then Create Diagnostic File… A save file dialog box will appear.
3.
Provide a name for the file.
4.
Open the file in Notepad or another text editor to view the contents of the file.
The diagnostic information provided includes information about your computer environment (including your HostID), the contents of your license file (if your computer is a Standalone computer or a Network License Server), and diagnostics from the RLM subsystem. CMG Support may ask you for this diagnostic information when troubleshooting a problem.
Configuring RLM in a Firewall Environment The RLM license server will use two TCP ports to make CMG licenses available to CMG Applications:
A Guide to Using CMG Licensing
•
The RLM license server listens on a port (by default, port 2700) for license requests from any ISV application.
•
The CMG license server listens on a port (by default, port 3137) for CMG-specific license requests. The RLM server will provide CMG applications with this value. Page 23
If you want to serve licenses across a firewall you will need to have a known port for the RLM server and the CMG ISV server and these ports must be open through the firewall. Although the CMG ISV server port number may be dynamically assigned by the RLM server, CMG recommends always setting a specific port number for the CMGL ISV server. By default, the CMGL ISV server is set to port 3137 in the License File on the ISV line as follows: ISV cmgl cmgl cmgl.opt 3137
You may change the port to any other open port by changing this value and restarting the RLM server. If you remove this value, RLM will assign a port dynamically at startup. It may assign different values each time the server is started, so this may be difficult to configure in a firewall environment. By default, the RLM Server is set to port 2700 in the License File on the HOST line as follows: HOST UNKNOWN 66393ca9 2700
You may change the port that the RLM server listens on by changing the value on the HOST line in the license file and restarting the RLM server. If you do this, you must edit your CMG_LIC_HOST environment variable to reflect this. The syntax of the CMG_LIC_HOST environment variable is as follows: CMG_LIC_HOST=hostname:port
For example, if a Network License Server is on computer computer123 and it is listening on port 2727, CMG_LIC_HOST should be set to the following: CMG_LIC_HOST=computer123:2727
Page 24
A Guide to Using CMG Licensing
Configuring the RLM and ISV Options Files
You can configure how the licensing works at your organization using options files. There are two option files: The RLM Options file, which controls access to the functions in the RLM Web Interface and the ISV Options file, which controls how CMGL’s licenses behave. The RLM options file allows control over access to the status, reread, shutdown administration commands as well as control over the editing of options files themselves. The ISV options file controls how licenses work. This can include: •
Granting/limiting access to the licenses for defined groups and individuals.
•
Creation/maintenance of report logs of license usage.
•
Setting timeouts and roaming access.
Complete information and syntax for the RLM and ISV option files is available from the RLM End-User Manual. http://www.reprisesoftware.com/RLM_Enduser.html CMG does not create these files on installation. You can create them in the RLM Web Interface (recommended) or manually with a text editor. To access the option files with the web interface, open the following URL in a web browser: http://localhost:5054/home.asp. CMG recommends that you do this while logged onto the license server and not from a remote machine.
A Guide to Using CMG Licensing
Page 25
To modify the RLM Options file, first click the Status button (A) to show the status pane. Then click the EDIT rlm Options button (B). This brings up the Edit rlm Options pane:
To modify the ISV Options file, first click the Status button (A) to show the status pane. Next click the cmgl button (C) in the OPTIONS column of the ISV Servers table. This brings up the Edit ISV Options pane:
Page 26
A Guide to Using CMG Licensing
Common RLM Options The RLM options file allows control over access to the status, reread, shutdown administration commands as well as control over the editing of options files. Options are provided to either allow (INCLUDE or INCLUDEALL) or disallow (EXCLUDE or EXCLUDEALL) administration command usage. One way to restrict access is to allow administrative tasks to occur only on the license server. Access to that machine can in turn be restricted through normal system administrative avenues. 1.
Bring up the Edit rlm Options pane as described earlier.
2.
Add the following lines to the file: INCLUDE INCLUDE INCLUDE INCLUDE INCLUDE
A Guide to Using CMG Licensing
edit_options internet 127.0.0.1 edit_rlm_options internet 127.0.0.1 edit_transfer internet 127.0.0.1 remove internet 127.0.0.1 shutdown internet 127.0.0.1
3.
Click the Update Options button.
4.
Click the Reread/Restart Servers button.
Page 27
Accessing the RLM Web interface from a different machine will only allow the user to see current license status – they will not be able to remotely edit options or load/remove licenses or shut down the licensing service.
Common ISV Options There are numerous changes to the options file that you can make. Some of the most common ones outlined here are: •
Configuring license timeout
•
Creating a report log of license use.
•
Restricting access to certain licenses.
For more information see the section The ISV Options File in the RLM EndUsers Manual: http://www.reprisesoftware.com/RLM_Enduser.html.
Configuring License Timeout CMG applications are configured to release licenses they have checked out when they are finished with them, or when they experience a non-standard program termination. Under some situations, such as when the network connection to the Network License Server has been lost, the license server may not be told the licenses are no longer needed and they will not be released. This condition will persist until an administrator explicitly releases the licenses through the RLM Administration page. You can configure your system to automatically check licenses back in to the server if the client application has not been heard from for a period of time.
Page 28
1.
Bring up the Edit ISV Options pane as described earlier.
2.
Add the following line to the file: A Guide to Using CMG Licensing
TIMEOUTALL 120
3.
Click the Update Options button.
4.
Click the Reread/Restart Servers button.
The value after the TIMEOUTALL directive is the number of seconds of inactivity that should pass before the server checks the license back in. As all CMG applications contact the server on a regular basis, any value above 2 minutes is reasonable. If a license is checked back in because of a timeout situation, the following will happen: •
The checked-in license is available for any other application instance to use. If a simulator run has been queued up waiting for a license, it will start running when it acquires this license.
•
If the application that had the license that was checked in is still running, it will try to reacquire the license for 30 minutes. If no other application has checked the license out, the running application will reacquire it and will continue running. If it cannot reacquire a license within 30 minutes, it will exit.
Enabling the Report Log In order to get detail on CMG license usage, you need to enable the CMG report log: 1.
Bring up the Edit ISV Options pane as described earlier.
2.
Add the following line to the file: REPORTLOG +[file]
3. A Guide to Using CMG Licensing
Click the Update Options button. Page 29
4.
Click the Reread/Restart Servers button.
Replace [file] with the path and name of the file you wish for the report log. The ‘+’ before the filename tells the Reprise server to append log information to an existing file if it exists. If the ‘+’ is left off, the Reprise server will create a new file every time it starts. By default, the Reprise server restarts every night at midnight. Paths with spaces in them should be enclosed in quotations; for example: REPORTLOG "+C:\Program Files\CMG\RLMSecure\logs\cmgusage.log"
Rotating the Report Log Information is written to the report log every time a CMG license is checked out, checked in, or any time a user is denied a CMG license. This means that the report file can get quite large. You may configure the Reprise server to create a new report log at regular intervals using the ROTATE directive in the ISV Options page: ROTATE [frequency]
The [frequency] parameter may be daily, weekly, monthly, or a number representing the number of days between rotations. When the Reprise server rotates the file, it renames the old logfile by appending the date to the filename.
Analyzing the Report Log A lot of information is written to the report log, but the entries most likely of interest are the following:
Page 30
A Guide to Using CMG Licensing
•
Checkout: Each time a license is checked out, an OUT line is written to the report log.
•
Checkin: Each time a license is checked in, an IN line is written to the report log.
•
Checkout Denial: If all licenses are in use when an application attempts to check out a license, a DENY line is written to the report log.
Information on the contents of these lines is available in the RLM End-User Manual at http://www.reprisesoftware.com/RLM_Enduser.html. You may choose to build your own analysis tools for this information, or you may consider a commercially available third-party analysis tool.
Third-Party Analysis Tools Reprise has a number of partners that provide tools that analyze report log data. These tools may help you get information on your overall license usage, and may help enable processes such as license usage departmental bill-back. The current list of Reprise partners may be found at http://www.reprisesoftware.com/usage_reporting.htm.
Restricting Access to Licenses There are times when you might want to prevent certain users from using some or all of the software. There are other times when you will want to set aside licenses for a specific group to use. Reprise allows you to include/exclude/reserve licenses in the ISV options file. •
INCLUDE allows only the specified individuals to use the license. Nobody else can use it.
•
EXCLUDE prevents the specified individuals from using the license. Everyone else can still use it.
•
RESERVE sets aside a specified number of licenses for the individuals. No one else can use the reserved license.
Users, hosts, IP addresses, groups of users and groups of hosts can all be specified. Example: A university with three professors who use STARS (stars_unlimited) and a classroom with ten University Solver (solve_university) licenses for student use. Thirteen Builder and Results licenses are provided for both. We can restrict everyone except the professors from using the STARS licenses by defining a group and then including that group for the STARS license: GROUP professors pym richards xavier INCLUDE stars_unlimited group professors
The GROUP designation creates a group (professors) that includes a list of users that are in the group (in this case, user pym, user richards and user xavier). The INCLUDE line says that only members of the group professors can use the stars_unlimited license. Users who are not part of that group cannot use the license at all.
A Guide to Using CMG Licensing
Page 31
Next, we reserve three Builder and Results licenses for the group. As a single CMGL license is implemented as a block of twenty keys, this means we must reserve a total of 60 builder keys and 60 results keys. RESERVE 60 builder group professors RESERVE 60 results group professors
Users who are not part of the group professors can still use Builder and Results, but they cannot use all of the licenses because some are unavailable to them. The Edit ISV Options pane should look like this:
Finally, we need to click the Update Options button and the Reread/Restart Servers button. There are many more ways to restrict license usage in the ISV options. Check the section on The ISV Options File in the RLM End-User manual: http://www.reprisesoftware.com/RLM_Enduser.html.
Page 32
A Guide to Using CMG Licensing
Using a Hardware Key (Dongle)
The Reprise licensing allows for the use of a hardware key (dongle). You should only use dongles provided to you by CMG. These are not normally supplied to CMG clients unless requested. Please contact your CMG Marketing Representative if you think dongle-based licensing is right for your company. Dongles are typically used when you have a single set of licenses that you want to use on multiple computers that do not share a network. Roaming is another solution to this situation. Refer to Roaming on page 14.
Requirements for Dongle-based Licensing The dongles that CMG supplies are USB Protection Devices that work on Windows. The stand-alone computer or license server should be running Windows and have a standard USB port. In general, any computer can use dongle-based licensing when the following conditions are true: •
The computer has the dongle drivers installed.
•
The dongle is attached to the computer.
•
The computer has a license code file installed that uses the dongle’s internal hostid.
Thus you could have multiple computers with the drivers and license code file installed, but only the computer with the dongle attached can make use of the CMGL software.
Installing the Dongle Drivers The RLMid1 dongle is a hardware key manufactured by Aladdin Knowledge Systems. Installation on a target system can be accomplished in three ways:
A Guide to Using CMG Licensing
•
Use Windows "Found New Hardware" to automatically load the drivers (preferred).
•
Use the RLMID1 driver installer (from the Reprise Software Web site) to do the driver installation.
•
Use the RLMID1 driver installer on the CMG General Release CDROM (directory EXTRAS\RLM Dongle Driver) to do the driver installation.
Page 33
Using Windows to Automatically Install Drivers In order to use Windows to automatically do the driver installation, simply plug the device into the computer, and Windows will detect the new device. If you first get a permissions screen asking if it is OK to use Windows Update to locate the driver, indicate that permission is granted. You will get the Found New Hardware wizard which will install the drivers for the "USB Protection Device" for you. (Note: The device may alternately be called "HASP HL 3.xx" or "Aladdin USB Key").
Select Install the software automatically (Recommended), and then click Next. Windows will locate the driver and install it. The Completing the Found New Hardware Wizard window will be displayed, as shown below. Click Finish.
Page 34
A Guide to Using CMG Licensing
Installing the Drivers Using the Installation Program If for some reason Windows fails to update the driver automatically, you can use the driver installer. If you are connected to the Internet, use the driver installer located at: http://www.reprisesoftware.com/drivers/rlmid1.zip. If you are not connected to the Internet, CMG provides these drivers on its General Release CD-ROMs in the directory “EXTRAS\RLM Dongle Driver”. We recommend that you use the most up-to-date driver from the Reprise Web site. To run the installer: 1. Save the installer (rlmid1.zip) to disk. 2. Extract the zip file. 3. Navigate into the rlmid1 directory, and then run the RLMID1 installer application. 4. When the installer comes up, select Modify (if it is not already selected) and then press Next.
A Guide to Using CMG Licensing
Page 35
Page 36
5.
On the Select Features window click Next.
6.
On the Ready to Modify the Application window click Next. The HASP SRM Run-time has been successfully installed window is displayed.
A Guide to Using CMG Licensing
7.
Click Finish. The drivers are installed and you are ready to use the RLMID1 devices.
Note: An RLMID1 device can be used by any RLM-licensed application on the system, in other words, there is nothing ISV-specific about the device.
A Guide to Using CMG Licensing
Page 37
Reprise Utilities
All Reprise utilities are also available through the Reprise License Server Administration Web page.
rlmdown Shuts down the license server(s). Usage for rlmdown is: rlmdown [isv]
isv is the name of the software vendor. To shut down all rlm servers, enter rlmdown. To shut down only the CMGL server, while leaving other license servers alone, enter rlmdown cmgl.
rlmhostid Reports the HostID information for the computer. Usage for rlmhostid is: rlmhostid -q [[-]32|ether|ip|internet|host]
Each command line option reports a different piece of HostID information, as follows: •
rlmhostid -32 reports the computer’s 32-bit hard-disk ID.
•
rlmhostid -ether reports the Ethernet MAC address.
•
rlmhostid -ip and rlmhostid -internet report the computer’s IP address.
•
rlmhostid -host reports the computer’s hostname.
The –q option suppresses the utility’s banner and copyright information.
rlmnewlog Creates a new logfile for recording licensing transactions and errors. Usage for rlmnewlog is: rlmnewlog isv log-file-name
isv is the software vendor – cmgl for example – and log-file-name is the name of the new logfile.
Page 38
A Guide to Using CMG Licensing
rlmremove Forces an in-use license back into the pool for use by subsequent applications. Usage for rlmremove is: rlmremove [-q] server-host port isv handle
server-host is the machine that the license server is on. port is the port used to communicate with the server. isv is name of the software provider – cmgl for CMG licenses. handle is the handle of the application using the license. Server-host, port and handle are all provided by rlmstat.
rlmreread Forces the license manager to reread the License File. Usage for rlmreread is: rlmreread [isv]
isv is the name of the software vendor. To reread all License Files for all software vendors, enter rlmreread. To reread only the CMG License File, while leaving other license servers alone, enter rlmreread cmgl.
rlmstat Retrieves status from the license servers and prints it. Control over the status retrieved from rlmstat is specified as follows: rlmstat [-a] [-i [isv]] [-l [isv]] [-n [node]] [-p [product]] [-u [user]] Option -a
Parameter (no parameters)
Result Print all status from rlm and all ISV servers.
-avail
[-i isv] [-p product] -b
Reports free license availability.
-i
Display this isv only
Display license checkout info from ISVs.
-l
Display this isv only
Display license pooling info from ISVs.
-n
Display licenses from this host only
Display license checkout info from ISVs.
-p
Display licenses for this product only
Display license checkout info from ISVs.
-u
display licenses from this user only
Display license checkout info from ISVs.
rlmswitch Switches the debug log info to a new file Usage for rlmswitch is: rlmswitch [isv] new-file
rlmswitch causes the server isv to close the current debug log file and begin output to new-log-file-name. If isv is not specified, or if specified as rlm, the rlm server's debug log is switched. A Guide to Using CMG Licensing
Page 39
How CMG Applications Are Licensed
Each copy of a CMG application you have licensed is enabled by a License Key Line in the License File we provide to you. CMG uses a model where each copy of an application you have licensed requires a count of twenty on the License Key Line. For example, if you have licensed three copies of GEM, there will be a count of 60 on the gem_unlimited License Key Line. The CMG graphical applications (Builder, Results, WinProp, and CMOST Studio) are licensed on a per-user basis. This means that if more than one copy is run by a user on a given computer, it still only checks out one license. The simulators, however, are licensed on a per-instance basis. Each time a simulator is run a license is checked out. For example, if you run two simultaneous copies of STARS in a session, two licenses (or a License Key count of 40) are checked out. CMG enables options through License Key Lines as well. If you have licensed an option from us (such as Parallel Tokens or Dynagrid) you will see these options enabled through License Key Lines as well. Note that some older options (such as a link between IMEX and Forgas) are now enabled for all customers, and therefore License Key Lines for these options will appear in every License File. University licenses enable the use of any of the simulators (IMEX, STARS, or GEM), but with a limit on the number of grid blocks that may be used in any model. These licenses are intended for academic usage and may not be used for commercial work.
Page 40
A Guide to Using CMG Licensing
