Installing floating licenses for DS-5

This tutorial explains how to install your floating license on a single server, whether you are installing and configuring a new license or renewing your license.

Installing floating licenses for DS-5

DS-5 floating licenses enable you to share a single license with multiple users as long as it is used at different times. When a license is released, it immediately becomes part of a common license pool, available to the next user who needs it. Floating licenses can be made available to anyone on the same network up to the limit specified in the license file.

This tutorial explains how to install your floating license on a single server, whether you are installing and configuring a new license or renewing your license.

Floating license options available in DS-5

DS-5 supports single server and three-server floating license installations.

Single server - The simplest system to configure, but if the server is unavailable, clients cannot use licensed tools until the fault is rectified.

Three servers - Using three separate license servers permits load balancing and server redundancy resulting in increased reliability. The license file is locked to the host ID (MAC address) of three separate floating license servers.

Things to remember when using three servers to implement a floating license scheme:

  • All three servers must be available when the floating license server starts. One of the servers can be stopped after the initial start-up.
  • All the servers can contact each other over the Local Area Network (LAN).
  • The clients can also contact these servers over the LAN.
  • Two servers must be operational at all times.

For advanced scenarios using three servers, see the FlexNet License Administration Guide as listed in the References section.

Licenses are assigned to a single legal entity. Contact the Arm licensing team if your license is to be shared by more than one legal entity.

Prerequisites

Before attempting this tutorial, you must:

  • Ensure that you are using the latest server utilities provided with DS-5.
  • Take note of your license server host ID and type. The host ID is the media access control address (MAC address) of your network interface. You must use the address of a physical network interface, not a virtual network address or the address of a wireless interface.
  • Using your serial number, create and download a FlexNet floating license file from the Arm License Management portal.
    1. Login to the Arm License Management portal.
    2. Go to the Software Licenses area, and click Arm Licenses.

      Silver Software Licences Area

    3. Under the Arm Self Service section on the left-hand side of the page, click Licenses > Generate.

      ARM Self Service

    4. On the Generate Licenses page, enter your Serial Number and click Get License.

      Generate Licenses

      Note:

      Once a license is generated, a serial number is linked to your Arm account. If you have any questions or require assistance, contact Arm license support.

    5. On the next page, the details of your license are listed.
      • In the Quantity to Fulfill field, enter the number of seats you plan to use. You can either register all seats available in your serial number to a single host ID, or split your seats between different host IDs. This would be helpful if, for example, you want to split your seats between multiple servers.
      • In the Server Host details section, select the appropriate Server Host ID type, and enter the Server Host ID.

      Generate Licenses - License details and Server host

    6. Check the details of your license and host server and click Confirm. If you want to make changes, click Back to go back to the previous page.

      Generate Licenses - Confirm details and host ID

    7. Click View to view the license file contents.

      Generate Licenses - Check License file

    8. On the license file page, click Save to download it to your preferred location.

Installing and configuring floating licenses

To install and configure a floating license, you have to:

    1. Download the FlexNet software licensing utilities relevant to your operating system from the License Server Management software download page. 
      What are FlexNet software licensing utilities?

      The FlexNet licensing utilities provided by Arm are programs that allow you to install and manage Arm licenses.

      They are:

      • armlmd - The Arm vendor daemon.
      • lmgrd - The FlexNet server daemon.
      • lmutil - The FlexNet licensing utilities.

        These utilities are available for Windows, Linux, and Mac host platforms.

      • lmtools.exe - The LMTOOLS graphical user interface (GUI) utility . A Windows only GUI tool for FlexNet licensing utilities.

      Windows users can set up and manage their server using either the GUI-based lmtools.exe utility or the command-line tools.

      The licensing utilities are also available within a DS-5 installation, usually under <DS-5 install folder>\DS-5\sw\FLEXnet<version number>

    2. Extract and copy them to a dedicated directory on your license server, for example C:\FlexNet.
    3. Optionally, create a license server debug log file, for example, license_server.log
    4. Modify the PATH environment variable to contain the location where you copied the utilities.
    5. Only on Linux and Mac host platform license servers: Run the makelinks.sh script in the license utilities directory.

      The makelinks.sh script creates a series of links to the lmutil program, one of which is for lmhostid. This script is in the appropriate directory for your platform.

    Note:

    • Where <DS-5 install folder> is the location where DS-5 is installed and <version number> is the version number of the FlexNet software licensing utilities bundled with DS-5. Select the utility appropriate to your host platform.

    • Changes to license file formats might mean that an older license server will not support a new tools license. Ensure that the version of the license server utilities you have is compatible with your DS-5 client.

      For more information, see the FAQ: Which version of the license server daemons should I run?

    1. Copy the license file that you obtained from the licence portal to a location on the server.

      Note: Arm recommends that you put the license file in the same directory as your license utilities.

    2. Modify the license file:
      1. Change this_host to the name of your server.
      2. Add in the server port number after the host ID number. Typically this is 8224 for Arm licenses.

      For example, if your server is called MyServer, and your host ID is 0000124241bc, the modified license entry would be:

      SERVER MyServer 0000124241bc 8224

    3. Save the license file.

    This completes the changes that you need to make to the license file for this tutorial.

  • If you are using the Windows only LMTOOLS GUI (lmtools.exe) utility, after preparing the license server and modifying the license file, you have to create a license service.

    1. Locate and double-click lmtools.exe in the utilities that you copied to the server. This starts the LMTOOLS utility.
    2. In the Service/License File tab, ensure that the Configuration using Services option is selected.

      Configure Using Services Option

    3. Navigate to the Config Services tab, and configure a new service:
      1. Service Name - Enter a name for your license service, for example: DS-5 License Service.
      2. Path to the lmgrd.exe file - Specify the path to the lmgrd.exe file.
      3. Path to the license file - Specify the path to the license file. Browse and select the license file you copied and modified as part of the copying the license file on server steps.
      4. Path to the debug log file - Specify the path to the license debug file that you created as part of preparing the server steps.
      5. Select the Use Services option. This activates the Start Server at Power Up option. Select it also.

        This ensures that the license server starts automatically if it has been rebooted for some reason, such as a power outage or maintenance.

      6. Click Save Service to save this as a new service.

      New License Service

  • After creating a new license service, you now need to start the license service:

    • On Windows servers

      To start the license server using the LMTOOLS utility:

      1. In the LMTOOLS utility, select the Start/Stop/Reread tab. The available FlexNet license services are listed in the dialog. Select the service you created.
      2. Click Start Server to start the license server.

        You can view the server status in the status bar.

        Successful Server start

      To start the license server using the command line:

      1. Navigate to your license utilities directory.
      2. Enter lmgrd -c <license_file> -l <logfile_name>,

        where <license_file> and <log_file> are the fully qualified path names to the license file and license debug log file.

      1. Navigate to your license utilities directory.
      2. Enter nohup lmgrd -c <license_file> -l <logfile_name>,

        where <license_file> and <log_file> are the fully qualified path names to the license file and license debug log file.

  • The final step is to configure the clients to obtain their license from the license server. One way to do this is to use the Arm License Manager available in DS-5.

    1. Start Eclipse for DS-5, and from the main menu, select Help > Arm License Manager.
    2. In the Arm License Manager, click Add License to display the Add License dialog.
    3. In the Add License/Obtain a new license dialog, select the Use an existing license file or license server address option and click Next.
    4. In the Add License/Enter existing license details dialog:
      1. Select the License Server option.
      2. Host - Enter the name of your server, for example MyServer.
      3. Port - Enter the port number that you want to connect to, for example 8224.
      4. Click Finish. This adds the license to the license manager.
    5. Select a toolkit in the Arm License Manager.
    6. Click Close.
    7. In the Confirm Restart Eclipse dialog, click Restart Eclipse. DS-5 restarts with the license installed and the toolkit you selected.

    You can view the installed license and the toolkit you selected in the Arm License Manager dialog. For example:

    View Installed License and Toolkit

Renewing your floating license

Follow the instructions in the Renewing your support and maintenance entitlement tutorial to renew your support and maintenance entitlement and generate a new license file. After generating your license file, complete the below steps to replace your existing floating license.

To renew and replace a floating license on an existing Arm license server, you have to:

    • On Windows servers

      To stop the license server using the LMTOOLS utility:

      1. Double-click the lmtools.exe utility to start the LMTOOLS utility.
      2. Navigate to the Start/Stop/Reread tab.
      3. Click Stop Server. You can view the status in the status bar of the LMTOOLS utility.

      To stop the license server using the command line:

      1. Navigate to your license utilities directory.
      2. Enter lmutil lmdown -c <license_file>, where <license_file> is the path to your license file.
      3. Enter Y when prompted.
      1. Navigate to your license utilities directory.
      2. Enter lmutil lmdown -c <license_file>, where <license_file> is the path to your license file.
      3. Enter Y when prompted.
  • After stopping the license server, you need to copy the license file, and make some modifications to it.

    You can delete your older license file and replace it with the newer one or save the new license file under a new name.

  • Restart your license server

    After making changes to your license file, you must restart the license server.

    • On Windows servers

      To restart the license server using the LMTOOLS utility:

      1. In the LMTOOLS utility, navigate to the Config Services tab.
      2. Ensure that you have selected the correct license file in the Path to the license file field. If not, select the correct one.
      3. Navigate to the Start/Stop/Reread tab and click Start Server. This starts the server, and you can see the status in the status bar.

      To restart the license server using the command line:

      1. Navigate to your license utilities directory.
      2. Enter lmgrd -c <license_file> -l <log_file>.

        Where <license_file> and <log_file> are the fully qualified path names to the license file and license debug log file which you copied and created as part of the preparing the server step.

    • On Linux servers
      1. Navigate to your license utilities directory.
      2. Enter nohup lmgrd -c <license_file> -l <log_file>.

        Where <license_file> and <log_file> are the fully qualified path names to the license file and license debug log file which you copied and created as part of the preparing the server step.

References

You might find these references useful: