Flexman Installation and Configuration Guide
Flexman Installation and Configuration Guide
Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law. Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or entity for any actions, claims, loss or damage arising from the use or possession of any information, particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it (including source code, object code, any data contained in it, the manual and any other documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries. All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where such permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently displayed at the beginning of every copy that is made. The manual and associated documentation may not be adapted, reproduced, or copied, in any material or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product described in this publication may be incorporated into any third-party software, product, machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution. The AVEVA products described in this guide are to be installed and operated strictly in accordance with the terms and conditions of the respective license agreements, and in accordance with the relevant User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited. First published April 2010 AVEVA Solutions Ltd, and its subsidiaries AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised use of the AVEVA or Tribon trademarks is strictly forbidden. AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its subsidiaries, registered in the UK, Europe and other countries (worldwide). The copyright, trade mark rights, or other intellectual property rights in any other product, its name or logo belongs to its respective owner.
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Flexman 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1 Upgrading from Flexman 3 or Flexman 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2 Supported Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2 Installing a Network License Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2 Special Circumstances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:3 Further Information and Guidance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:3
FlexmanConfig Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1 How an AVEVA Product Searches for a License . . . . . . . . . . . . . . . . . . . . . . . . 4:2 How to Suppress License Expiry Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
FLEXlm License Finder Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1 Firewalls and Port Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:2 License Error -8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3 C:\flexlm Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:4 License Server Filling-up with Licensing Daemons . . . . . . . . . . . . . . . . . . . . . . 7:4 Port Number Already in Use Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:4 License Server List Not Working . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:4 Vendor Daemon Errors: Invalid License Key . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5
ii
Introduction
Flexman 5.1 was developed for 32-Bit machines only. Flexman 5.2 has installers for both 32-Bit and 64-Bit operating systems. Apart from installing into folders with different names, each of these Flexman 5 installations is functionally the same.
1.1
Flexman 5
Flexman is the AVEVA wrapping around the FLEXnet licensing system, previously called FLEXlm. AVEVA product releases from mid 2010 require Flexman 5 so any existing Flexman License Service must be upgraded. With the possible exception of some very old product releases, all AVEVA software that has been running with Flexman 3 or Flexman 4 will continue to run with a Flexman 5 License Server and License File.
1:1
1.2
The steps are described in detail in License Service Installation & Administration, but in brief: Install Flexman 5 while the existing license service is still running Copy a new license file into the FlexMan5.2 folder Create a new License Service with a new name Stop the existing License Service Start the new Flexman 5 License service Remove the previous Flexman 3.1 or 4.1 License Service and then un-install it
1.3
Supported Hardware
Please refer to the release notes for a full list of supported hardware platforms. If you have been running your Flexman licensing service on Windows Server 2000, you are advised to upgrade to a newer operating system as soon as possible as Microsoft no longer support this operating system.
1.4
1:2
1.5
Special Circumstances
Installation can be more complex in certain situations and the following are covered in Special Situations: Installing a License Service on a laptop. 64-Bit Operating Systems. Machines that are locked-down so that users have restricted access rights. Another product such as AutoCAD that also uses FLEXnet is already in use. Running AVEVA products via Citrix, Remote Desktop or Terminal Services Setting access to a License Service from within a DOS batch file. Running AVEVA product releases from 2002 or earlier.
1.6
1:3
1:4
2
2.1
The Vendor Daemon from AVEVA Solutions AVEVA's utility for configuring a PC and diagnosing Licensing problems AVEVA's utility for configuring a PC and diagnosing Licensing problems This document from AVEVA FLEXnet documentation from Flexera Software
The customer needs the Server Install to set up a license service - this will be a server machine on the network, a laptop or a free-standing desktop computer. The Client Install provides the FlexmanConfig tool for configuring the connection to the License Server and is needed wherever an AVEVA product is being installed.
2.2
2:1
Copy the highlighted text and send it in an e-mail with your request for a license. Where there are two or more Ethernet adaptors on a PC, decide which Ethernet address should be used for the license file and inform AVEVA. This must be for a network adaptor that will never be disabled. Note: The utility lmtools is used to obtain the required HostID information but does not handle the situation of two or more Ethernet addresses, and is not recommended. Another possibility is to use the DOS command IPCONFIG -ALL Given the hostname and Ethernet address, the AVEVA License Administrator will send a license file specific to this machine. AVEVA products can not be used until a license service is started using this license file. The license file will not work on any other machine.
2:2
2.3
2.4
2:3
2.5
2.6
2.7
On the Service/License File tab make sure that Configuration using Services option is selected. Always tick LMTOOLS ignores license file path environment variables when LMTOOLS is being used to configure a License Service.
Note: These screenshots are based on LMTOOLS 11.8 running on Windows XP SP2. Other versions may have a different appearance.
2:4
Important: Take Care When Upgrading From Flexman 3.1 or Flexman 4.1. In the next step type in a new name so that a new License Service is created. Failure to do this will cause the existing License Service to be redefined. This will work but means that you will be unable to revert quickly back to the previous License Service if you need to resolve any issues with the new Flexman 5 Service. Select the Config Services tab: There are 4 fields and 2 tick boxes to complete:
Service Name [1] Type in a new name for a License Service that will be meaningful among the list of other Windows Services later on, such as AVEVA Flexman 5. Note: Take special care at this point if a License Service, such as Flexman 4.1, already exists. You MUST type in a new name at this point to avoid making changes to an existing License Service. Path to the lmgrd.exe file [2] Select the Browse button and navigate to the FlexMan5.2 folder. Select the lmrgd.exe file and click Open to confirm. Note: It is possible to share the lmgrd.exe used for a product from another supplier. However, AVEVA recommends using a separate lmgrd.exe for each Vendor Daemon to avoid version incompatibilities. Path to license file [3] Repeat for the path to the license file using the Browse button.
2:5
Path to the debug log file [4] Select the Browse button and in the pop-up dialog box make sure you are in the FlexMan5.2 folder. Type debug.log in the Filename field and click Open to confirm. Note: The debug.log file does not need to exist yet - the License Service will automatically create a log file with the name previously given when the License Service is started.
Tick the Use Services box [1] and then Start Server at Power Up box [2]. Click the Save Service button [3] and confirm Yes when prompted.
2.8
2:6
Select the Start/Stop/Reread tab. Click the Stop Server button to stop license service immediately. Note: NEVER tick Force Server Shutdown - it can result in other License Services on the network being shut down unintentionally. AVEVA products do not currently support 'Borrowed' licenses so there will never be any need to use this option. Do not rush to start the new License Service - allow sufficient time for the service that has just stopped to release the ports it was using.
2:7
2.9
Click the Advanced Settings button [1]. Tick Restrict lmdown to work only from node where lmgrd is running [2]. This makes sure that the license service cannot be shut-down inadvertently from another machine on the network with lmtools or the command-line utility lmdown. Click the Start Server button [3]. The license manager should now be active. Note: Do not rush to start the new License Service - allow sufficient time for the service you have just stopped to release the ports it was using. Note: If by mistake you modified an existing License Service, rather than naming a new License Service, then to apply the changes you would need to stop and then restart the existing License Service.
2:8
2.10
This shows what license features are now available from the License Server, by default for all License Servers running on the network, the list can be narrowed by specifying an individual server. Note: Before re-running Perform Status Enquiry click on Edit>Clear Window to empty the window of any previous enquiry results. Using the Task Manager Another way of confirming that the License Service is running is to use the Windows Task Manager. Select the Processes tab and look to see that there is one cadcentre.exe process and at least one lmgrd.exe process running. With some versions of FLEXnet, or if running a product from another vendor that is also licensed with FLEXnet, it is possible to see two or more lmgrd processes running, but this is normal. Note: Tick Show Processes from all users in the Task Manager, to display correctly.
2.11
2:9
When the Flexman 5 License Service is running correctly, you should remove the previous Flexman Windows Service to prevent the computer from attempting to start both services at a reboot. Note: If you prefer not to uninstall the previous Flexman service just yet, you must disable the Windows service using Control Panel> Administrative Tools > Services. Use the LMTOOLS ConfigServices tab:
Make sure that the name of the previous Flexman License Service is selected. Click on Remove Service. Un-install the previous Flexman License Service using Control Panel > Add/Remove Programs. When the previous Flexman has been uninstalled, delete the appropriate folder manually: C:\Program Files\cadcentre\Flexman 3.1. C:\AVEVA\FlexMan4.1
2:10
Restarting the License Service Go to Control Panel > Administrative Tools > Services.
3:1
Select the name of the Windows Service corresponding to your License Service. Click on Restart the Service Check the state of the license service using the lmtools utility or by inspecting the debug.log file.
Note: This is the preferred approach to using lmtools, as it is quicker and should avoid interrupting programs running during the update process. In particular be advised against using the lmtools ReREAD facility, which only partially updates the license service.
3:2
4
4.1
AVEVA products need to know where to find an active License Service running a license file from AVEVA. FLEXnet tries to be helpful by searching through all the locations it knows about. Unfortunately, there are rather too many possibilities and as a result the behaviour of FLEXnet can seem unpredictable.
4:1
AVEVA recommends the use of our configuration tool FlexmanConfig to get a full picture of the various settings involved and for making any required changes. The simplest and most reliable approach is to set the vendor-specific Registry Entry, such as CADCENTRE_LICENSE_FILE, and remove all other settings, as shown here. Note: Take care not to delete settings belonging to other vendors' software products also licensed with FLEXnet that use the LM_LICENSE_FILE setting. Click Set for each change made and the new settings will only take effect after Save and Exit have been clicked. AVEVA recommends using the Port@Host format to avoid problems with firewalls. Note: On a 64-Bit platform, separate Registry settings are needed for 32-Bit and 64-Bit programs. FlexmanConfig will help you set both to the same License Service. Important: If an AVEVA product pops-up a dialog box requesting the location of a licence file, you should CANCEL out of this dialog box and use FlexmanConfig tool to resolve the problem instead. See FLEXlm License Finder Dialog Box.
4.2
A blank USER Environment Variable setting has the effect of disabling a SYSTEM setting of the same name. Any one of these settings can be a list of three license servers separated by commas -This is how a Three Redundant Server configuration is defined (see License Server List). Usually, any one of these settings can be a list of license servers separated by semi-colons. This is how a License Server List is defined. (See Running the License Service in a Virtual Machine).
4.3
4:2
The warning period is set to 28 days by default. The warning period may be reduced by setting the environment variable: CADCENTRE_LICENSE_FILE_WARN_COUNTDOWN to an integer value not less than 3.
4:3
4:4
5.1
5.2
5:1
A copy of the same license file must be installed on each of the three machines. The license service is started on each machine in the usual way. Do not use three virtual machines on the same physical machine for a three redundant server configuration - the physical machine remains as a single point of failure. A machine on which an AVEVA product is running must be configured so that it is aware of the locations of all three License Servers. When using FlexmanConfig tool, the location of the License Server should be set to a list of server locations separated by commas.
Note: There was a bug in the version of FLEXlm used in AVEVA products released before the end of 2008 and that used Flexman 3.1. This bug limited the resilience of a threeserver configuration to surviving the first hardware failure: resilience was not reestablished without restarting all three of the License Services. Configuring the License Search Path for PDMS 12.x and other Recent AVEVA Releases Requiring Flexman 5 or Flexman 4.1 The license search path should list the license servers in the same order that they appear in the license file. If the PRIMARY License Server fails, a running application will automatically switch-over to the SECONDARY License Server and continue running. The port@host entries must be separated by a COMMA e.g. 2837@pat,2837@lee,2837@terry Configuring the License Search Path for PDMS 11.6 and Other AVEVA Product Releases Prior to Flexman 4.1 There was a FLEXlm bug in the implementation of three-server redundancy that meant an application could only ever find the first server in the list. The workaround is to define the search path as a License Server List, separating each port@host entry by a SEMICOLON e.g. 2837@pat;2837@lee;2837@terry Configuring the License Search Path for a Mix of Older and More Recent AVEVA Products (e.g. 11.6 and 12.x) In this case the search path must be defined as above as a License Server List, using the workaround required by PDMS 11.6 separating each port@host entry with a SEMICOLON e.g. 2837@pat;2837@lee;2837@terry However, PDMS 12.x and other newer products running at the time of failure of the PRIMARY License Server will not continue running in this case. It will be necessary to SAVE WORK and restart the newer application and it will then find the active SECONDARY License Server. However PDMS 11.6 and other older software will continue running.
5.3
5:2
5.4
5:3
5:4
6
6.1
Special Situations
Installing a License Service on Laptop
When AVEVA products are installed on a laptop or any other free-standing computer, it is also necessary to install and configure a License Service. In this situation the laptop user usually performs the role of License Administrator. A laptop will typically have more than one Ethernet Address so take particular care when ordering a License File and follow the instructions in How to Obtain a New License from AVEVA to select an Ethernet Address for a network adaptor that is always on and will never be disabled. It has never been possible with AVEVA license files to borrow an individual license from a network license service for use on a laptop, so a separate license file must be ordered for each laptop or free-standing computer. Note: Some companies set up a pool of Dongles with matching license files so that a license service can easily be set up on a laptop when it is required to go off-site.
6.2
6.3
Locked-down PCs
Some companies operate a strict policy of 'locking-down' machines so that the user has write access only to specified folders. It may not be possible in this situation for FlexmanConfig to create Registry settings, in this case it may be easier to set the User Environment Variable instead.
6.4
6:1
cadcentre Vendor Daemon only. Take special care not to damage the Shared License Settings needed by other products. There is believed to be bug in the version of lmtools 10.5.0 distributed with AutoCAD. Before reporting a problem to AVEVA, try using version 11.8 lmtools that is included in the Server install of Flexman 5. Note: When running products using FLEXnet licensing from different suppliers, it is possible to see many lmgrd License Manager Daemons running, but this is normal.
6.5
6.6
6.7
6.8
6:2
7
7.1
Troubleshooting
FLEXlm License Finder Dialog Box
When attempting to start an older AVEVA product that is unable to obtain a license, a FLEXlm License Finder dialog may be displayed as follows:
This indicates that something has gone wrong either with the settings on the user's PC or with the License Service itself. Note: AVEVA recommends to Cancel this dialog box. The following error box will be displayed and the exact wording will vary depending on the circumstances. Click OK to dismiss the error box and follow the Troubleshooting hints below.
7:1
Recommended approach: Run the Flexman Configuration tool FlexmanConfig and refer to the advice in Updating a License File of this document. The License Administrator should check the status of the License Service and look for any error messages in the debug.log file. If the fault cannot be identified locally, request help from AVEVA via e-mail. Include as evidence: the current license file; the debug log-file; a screen shot showing any error messages; and the analysis report from the Flexman Configuration tool.
7.2
7:2
As supplied, the line in the license file beginning SERVER ends with 744. This is the default port number for communicating with the License Server process lmgrd.exe. With a SERVER line set as in the example license file shown, using FlexmanConfig set the Vendor Specific Registry Entry to:
744@LGSERV01
However, firewalls are becoming increasingly diligent at shutting down ports and it may be necessary for this port to be opened manually by a System Administrator before the license manager can function. The VENDOR line in the License File does not, as supplied, specify a port number. To overcome problems with firewalls AVEVA recommends also adding a port number to the VENDOR line in the license file and this must be different from the Port Number on the SERVER line. For example:
7.3
License Error -8
There are three circumstances likely to give this error: 1. Attempting to Run an AVEVA Product via Remote Desktop or Citrix The license file received from AVEVA may not support working via Citrix or Remote Desktop using Terminal Services. License error -8 referring to the CADCID license feature is characteristic of this problem. Contact the account manager if experiencing this problem, the user may require a license to enable remote running of AVEVA products. 2. CLOCKING the Machine on which the License Service is Running Setting the system clock back is a trick sometime used to attempt to extend the life of a license file. The License Service recognises that this has happened and refuses to serve licenses. AVEVA advice is that it is necessary to completely re-install the operating system to clear this fault. Other than moving between time-zones, changing the system clock on your machine is not recommended. 3. You may also see this error with Flexman 3.1 and some very old product releases if the licensing of the product is based on the PACKAGE keyword.
7:3
7.4
C:\flexlm Folder
The version of FLEXlm used in Flexman 3.1 created lock files in the folder C:\FLEXlm on the license server machine. After upgrading to Flexman 5 the C:\FLEXlm folder is no longer required because a different mechanism is used. However, if you are running the Tribon M3 product at SP5 or earlier or any products based on FLEXlm licensing from other vendors, this folder may still be used. If the C:\flexlm folder is still needed, a problem can arise if access permissions to the C: drive are too restrictive. The License Service can fail to start if files cannot be created in the folder or this folder cannot be created in the first place.
7.5
7.6
7.7
7:4
7.8
7:5
7:6
The License Sequence Number changes each time the license file is renewed or updated. Header: # AVEVA License Generator v10.06a # # FLEXMAN 5 LICENSE FILE (COMPATIBLE WITH FLEXMAN 3/4) # # Customer: ukcamd1654 # Server [1] # Issued on: 10-Jun-2010 at 06:23 # # This is a COMPLETE license file for ONE server with the specified HOST ID # Do not attempt to combine this with any previous license file # Please rename this file as license.lic and replace the previous license.lic with this file # # DO NOT change the HOST ID [00110AA387D4] on the SERVER line # You may: # - change the default PORT NUMBER [744] on the SERVER line # - append a PORT NUMBER to the VENDOR line using the syntax PORT=1234 # For other permitted modifications to the VENDOR and SERVER lines see the # Flexera Software 'Licensing Administration Guide' # Any other alterations will invalidate this license file # SERVER ukcamd1654 00110AA387D4 744 Port Number can be changed VENDOR cadcentre PORT=7153 Port Number can be added USE_SERVER #
8:1
Increment Lines:
A Package line does not define any entitlement on its own - it just gives a name to a collection of component Features. The entitlement is defined in an Increment line which follows. The Increment line defines how many concurrent uses (seats) of a feature the customer is entitled to use and when the entitlement will expire. If the Increment refers to the name of a Package, the count applies to each of the component features of the Package. The inclusion of the keyword OPTIONS=SUITE means that the count sets a limit on the total number of people using the package, irrespective of how many components each person is using.
8:2