scl tutorial- managing leased licenses in a network · 2019. 10. 14. · contents...

SCL Add-on for RMSTutorial - Managing Leased Licenses in a Network

All information herein is either public information or is the property of and owned solely by Gemalto NV. and/or itssubsidiaries who shall have and keep the sole right to file patent applications or any other kind of intellectual propertyprotection in connection with such information.

Nothing herein shall be construed as implying or granting to you any rights, by license, grant or otherwise, under anyintellectual and/or industrial property rights of or concerning any of Gemalto’s information.

This document can be used for informational, non-commercial, internal and personal use only provided that:

• The copyright notice below, the confidentiality and proprietary legend and this full warning notice appear in all copies.

• This document shall not be posted on any network computer or broadcast in any media and nomodification of any partof this document shall bemade.

Use for any other purpose is expressly prohibited andmay result in severe civil and criminal liabilities.

The information contained in this document is provided “AS IS” without any warranty of any kind. Unless otherwiseexpressly agreed in writing, Gemalto makes no warranty as to the value or accuracy of information contained herein.

The document could include technical inaccuracies or typographical errors. Changes are periodically added to theinformation herein. Furthermore, Gemalto reserves the right to make any change or improvement in the specificationsdata, information, and the like described herein, at any time.

Gemalto hereby disclaims all warranties and conditions with regard to the information contained herein, including allimplied warranties of merchantability, fitness for a particular purpose, title and non-infringement. In no event shallGemalto be liable, whether in contract, tort or otherwise, for any indirect, special or consequential damages or anydamages whatsoever including but not limited to damages resulting from loss of use, data, profits, revenues, orcustomers, arising out of or in connection with the use or performance of information contained in this document.

Gemalto does not and shall not warrant that this product will be resistant to all possible attacks and shall not incur, anddisclaims, any liability in this respect. Even if each product is compliant with current security standards in force on thedate of their design, security mechanisms' resistance necessarily evolves according to the state of the art in securityand notably under the emergence of new attacks. Under no circumstances, shall Gemalto be held liable for any thirdparty actions and in particular in case of any successful attack against systems or equipment incorporating Gemaltoproducts. Gemalto disclaims any liability with respect to security for direct, indirect, incidental or consequentialdamages that result from any use of its products. It is further stressed that independent testing and verification by theperson using the product is particularly encouraged, especially in any application in which defective, incorrect orinsecure functioning could result in damage to persons or property, denial of service or loss of privacy.

© Gemalto 2016. All rights reserved. Gemalto, the Gemalto logo, are trademarks and servicemarks of Gemalto and areregistered in certain countries.

Product Version: 9.1

Document Number: 007-013342-001, Revision B

Release Date: August 2016

SCLAdd-on for RMS: Tutorial - Managing Leased Licenses in a NetworkDocument Number: 007-013342-001 Revision B Copyright 2016Gemalto All rights reserved. 2

CONTENTS

Tutorial - Managing Leased Licenses in a Network 1

CONTENTS 3

Introduction 5What are leased licenses? 5An Example Use Case 5User Roles 6

Get Familiar with the Sentinel Cloud Licensing Platform Deployment 7Key Points 7Deployment-specific Details E-mailed to Vendor 8

Deploy the RMS Components 10System Prerequisites 11Installation Steps 11Deliverables to Vendor’s Customer 12

Set up Network Licensing Environment at Vendor’s Customer Site 12Install the Sentinel RMS LicenseManager on a Server Machine 12Install and Configure SCP on a Server Machine 13Steps after SCP Installation and Configuration 14

Deployment Summary 14

Tasks 16

Define Features, Products, and Licensing Terms 17Launch Sentinel EMS 17Create Namespace 17Flexible LicenseModel Overview 17

License Terms Used in the Current Example 19Define Features 19Define Products 20What’s Next? 20

Provision Entitlements 21Define Customer 21Create Entitlement 21Activate Entitlement 23

Register Machine 24Extract Fingerprint of the RMS LicenseManager (by Customer) 24


Register Fingerprint with Customer’s Entitlement (by Vendor) 25

Retrieve and Consume Leased Licenses 26Prerequisites 26Specify Customer ID in SCP Configuration File 26Specify YPS Address in SCP Configuration File 27Start SCP and the RMS LicenseManager 27View the lservrc License File 27Run the Application 28Use theWlmAdmin Utility to View License Details (Windows) 28View the Usage File 30About Syncing Usage with SCC 30

View Billing Data and Usage Reports 31View Usage Data and Billing Data 31View Usage Reports 31

What’s Next? 33

Support Contacts 34


Introduction

This guide explains how to provision, consume, andmanage leased licenses in the Network mode by using the SentinelCloud Licensing (SCL) Add-on for RMS.

This document provides the following details:

• An abstract of the cloud infrastructure that enables Sentinel RMS to support license lease and usage analytics.

• Instructions on how to prepare an end customer environment (including the Sentinel RMS LicenseManager andclient machines) for consuming leased licenses in the network mode.

• Complete EMS workflow starting from defining features to activating entitlements and generating reports.

Note: If you are a new SCL customer, you should request for a trial SCL platform deploymentprior to implementing the procedures given in this guide. We also suggest reading the SCLAdd-on for RMS Overview Guide to have an understanding of leased licenses, licenseattributes, deployment modes, and license workflows.

It contains the following sections:

What are leased licenses?A license that lasts for a specific period of time (as governed by the lease duration defined in EMS) and needs to berenewed before its expiration. The license ownership remains in the cloud, and the client is granted the use of thelicense for a limited time period. The lease duration and renewal frequency of a license can be controlled from the cloud.

Licenses can be leased only in the Cloud Served - Lease Deployment Mode.

An Example Use CaseSuppose a software vendor offers a Calculator application for performing various mathematical functions ranging fromsimple arithmetic to complex logarithmic calculations. The vendor wants the flexibility to provide different flavors of theapplication to customers according to their needs. For example, a primary children’s school may like to use only thebasic arithmetic features of the application (such as, addition and subtraction), whereas an engineering collegemayalso use the advanced features (such as exponential and logarithmic).

The application is expected to be used in the connected corporate networks with small offline periods. The vendorwants to provide licenses of 1 year subscription, with 10-seat capacity. Tomaintain control over licenses, vendorleases licenses for a defined duration, say 24 hours. The end customers are able to use the application even when thenetwork is down (until the lease expires).

The vendor also wants to identify most-used and least-used application features to streamline future investments. Thevendor decides to license the Calculator application by using the SCL Add-on for RMS.

A break-down of the key characteristics identified from the above use case is:


Introduction

Characteristics Details

Name of the application to belicensed

Calculator

Features to be licensed Addition, Subtraction, Exponential, and Logarithm

Product packages to offer Basic 1.0 and Scientific 1.0.Basic 1.0 contains only Addition and Subtraction features. Scientific 1.0contains all the features.

License type Subscription (1 year), Floating (10 seats), Lease (usage tracking capabilities)

License deployment mode Cloud Served - Lease Network mode

Internet connectivity Connected with occasional disconnected periods

The above example will be used throughout this guide to explain the various steps involved in the workflow of leasing alicense.

User RolesThe various user roles are involved in the process of licensing, packaging, and consuming an application, such as:

• Gemalto’s SCL team that sets up the cloud back-end environment for a vendor.

• Vendor’s developers who works with the RMS APIs for licensing the application.

• Vendor’s EMS users, such as product manager, order taker, and sales person who perform entitlementmanagement activities (for example, managing features, products, licensemodels, customers, and entitlements).

• Customer’s administrator whomanages the Sentinel RMS LicenseManager.

• Customer’s end users who consume the licensed application.

SCLAdd-on for RMS - Tutorial - Managing Leased Licenses in a NetworkDocument Number: 007-013342-001 Revision B Copyright 2016Gemalto All rights reserved. 6

Get Familiar with the Sentinel CloudLicensing Platform Deployment

When a software vendor purchases the SCL Add-on for RMS, a Sentinel Cloud Licensing Platform (SCLP) is deployedfor the vendor. The SCLP deployment refers to setting up the necessary cloud infrastructure on a public cloud. Thecloud instances are set up for the following components:

• Sentinel Cloud Connect (SCC)

• Data Engine (DE)

• Directory Services (DS; also called YPS)

• Entitlement Management System (EMS)

• Databases

For detailed information on components, such as their functions and how they interact with each other, see the SCLOverview Guide.

Key PointsThe following are the key points related to the SCLP deployment:

• Instances for SCC, DE, DS, EMS, and databases are hosted on a public cloud.

• SCC is multi-tenant enabling a single server instance to servemultiple vendors. SCC is stateless which allowsrunningmultiple instances for load handling and fault tolerance.

• DE instance is vendor-specific.

• EMS server instance is also vendor-specific.

• DS is multi-tenant.

• All components are deployed in a load-balanced environment.

The following diagram depicts a basic SCLP deployment on a public cloud.


Get Familiar with the Sentinel Cloud Licensing Platform Deployment

Figure: The Sentinel Cloud Licensing Platform (SCLP) Deployment

Deployment-specific Details E-mailed to VendorOnce the Sentinel Cloud Licensing Platform is deployed, e-mails are sent to vendors containing details of the hostedenvironment, unique vendor keys, and secrets. These details are specific to each vendor, and include the following:


Get Familiar with the Sentinel Cloud Licensing Platform Deployment

Vendor ID

This is a unique confidential code assigned to a vendor by Gemalto on purchasing a Sentinel product.

Vendor Alias

This refers to the vendor name registered with Gemalto.

Secret Key, Secret Key ID

These are vendor-specific secrets used by the cloud components for authenticating licenses requests received fromcustomers.

YPSAddress

This is the URL of the server machine (cloud instance) where Directory Service (also known as YPS) is deployed. ThisURL is in the following format:

https://<YPS_HOSTS>/YPServer

Here, YPS_HOSTS is the domain name of the Directory Services (DS)machine.

An example of YPSAddress is:

• https://yps-trial.sentinelcloud.com/YPServer

EMS URL and Login Credentials

A vendor-specific URL of the EMS instance and the corresponding login credentials (user name and password) areprovided to a vendor in an e-mail.

A typical EMS URL looks like the following:

https://ems-trial-1w.na.sentinelcloud.com/vendorname/

The default user name and password for the EMS administrator are admin. These are recommended to be changed atthe earliest by vendor’s EMS administrator.

The above details are used while configuring the cloud-enabled RMS components, as will be covered in subsequentsections.


Deploy the RMS Components

Some of the RMS components are deployed by vendors, and some by their customers.

• Vendor-side Deployment: The vendor deploys the following:

– RMS SDK (using a serial number, called product key)

– Sentinel Cloud Plugin (SCP, explained in next section)

• Customer-side Deployment: The vendor’s customer deploys the following:

– The Sentinel RMS LicenseManager

– The licensed application

– A vendor-made, custom fingerprint extraction tool.

Note: Installations are done by an administrator role.

Figure: Items deployed by vendors and their customers



About SCP (Sentinel Cloud Plugin)SCP refers to the Sentinel Cloud Plugin that is integrated with the RMS components to provide cloud licensingcapabilities. SCC and the Sentinel RMS LicenseManager communicate with each other via SCP. The binary andconfiguration files of SCP are received by vendor in an email from Gemalto, as a separate item from SDK. SCP isdeployed as a service in customer’s network environment.

The vendor needs to install the RMS SDK by running the StartHere.exe available in the installationmedia.

This section provides a summarized version of required items and steps. For complete details on prerequisites andinstallation steps, refer to the section “Installation Information” in the Sentinel RMS Release Notes.

Note: The information given in this guide is forWindows platform only.

System Prerequisites• Youmust have Administrator privileges to successfully install RMS.

• Youwill require a valid serial number provided by Gemalto. The installer prompts you to enter the serial numberspecific to you.

• The hardware requirements are:

– 32-bit or 64-bit processors

– Approximately 1.3 GB free hard disk space

– 2GB RAM onWindows 7, Windows 8 for 64- bit andWindows 2012

– 1GB RAM on all other

• The software requirements are:

– 32-bit version of Windows Vista, 7, 7.1, 8, 8.1, Windows Server 2008, 2012, andWindows 1064-bit version of Windows Vista, 7, 7.1, 8, 8.1, Windows Server 2008, 2012, andWindows 10

– Compilers:

– Microsoft Visual Studio 2008 Professional edition v9.0.30729.1 SP (for 32 and64-bit )

– Microsoft Visual Studio 2010 Professional edition v10.0.30319.1 RTMRel (for 32and 64-bit)

– Microsoft Visual Studio 2012 Professional edition v11.0.60610.01 Update 3 (for32 and 64-bit)

– Microsoft Visual Studio 2013 Professional edition

• Java Runtime Environment v1.5 or above for the Java interface.

Installation StepsFrom the installationmedia, run StartHere.exe to start the RMS installation wizard. Keep on clicking Next and followingthe on-screen instructions to complete the installation. Main points to consider are:

• Youwill need to specify SDK serial number received from Gemalto during installation.

• When prompted tomodify the system firewall settings, youmust keep the check box selected to allowcommunication with the Sentinel RMS LicenseManager.



• The default RMS installation directory is:

– On 32-bit: <OSdrive>:\Program Files\SafeNet Sentinel\Sentinel RMS Development Kit\<version>

– On 64-bit: <OSdrive>:\Program Files (x86)\SafeNet Sentinel\Sentinel RMS Development Kit\<version>

• With the RMS installation, the RMS LicenseManager is deployed automatically.

You will also need to install SCP as a service on the samemachine where you have deployed the RMS SDK. Thesteps are similar to those given in the section,"Install and Configure SCP on a Server Machine" on the next page.

Deliverables to Vendor’s CustomerThe vendor needs to provide the following items to customer for setting up the cloud-enabled licensing environment inthe network mode:

• The Sentinel RMS LicenseManager binary, named lservnt.exe forWindows (32-bit and 64-bit) machines. Vendorcan pick it from the RMS installation directory for providing to customers.

• SCP service, named sntlcloudps_[vendor_alias].exe forWindows (32-bit and 64-bit) machines.

• SCP configuration file, which has a vendor specific name such as sntlcloudp_configuration_[vendor_alias>.xml.

• A custom tool for fetchingmachine fingerprint which retrieves machine fingerprint by using the sntl_licensing_get_info API.

• The licensed application.

Note: Only the Cloud Served - Lease Network mode deployment has been covered in thisguide.

Set up Network Licensing Environment at Vendor’sCustomer SiteFor the network mode, a vendor’s customer needs to perform the following:

• Install the Sentinel RMS LicenseManager

• Install and configure SCP

The items described in the section Deliverables to Vendor’s Customer will be needed while performing the above steps.

Install the Sentinel RMS License Manager on a Server MachineFor using the licensed application in the network mode, a customer needs to install the RMS LicenseManager by usingthe binary file (lservnt.exe) received from the vendor.

Windows-only

The steps given in this guide are for theWindows platform only.

StepsAdministrator privileges are required to install and run the RMS LicenseManager.

To install the RMS LicenseManager, run the following command:lservnt.exe –X install



To start the RMS LicenseManager, run the following command:lservnt.exe –X startOnce this command is executed successfully, the RMS LicenseManager starts automatically after every systemrestart.

Note:To see a list of available command-line arguments for the RMS LicenseManager, execute thecommand:lservnt.exe –X help

Installation DirectoryBy default, the LicenseManager is installed at the following path onWindows 64-bit machine:

<OSDrive>:\Program Files (x86)\Common Files\SafeNet Sentinel\Sentinel RMS LicenseManager\WinNT\

However, youmay specify a different path during the installation process.

Checking Presence of the License ManagerAfter installation, to verify the presence of the RMS LicenseManager, check theSentinel RMS License Managerentry in the list of the services installed on the system.

Install and Configure SCP on a Server MachineCustomers also need to install SCP service on the samemachine where the RMS LicenseManager is installed. Theyreceive the SCP service and SCP configuration file from the vendor as an e-mail downloadable.

Note: A minimal set of instructions have been given in this guide for installing and configuringSCP. For detailed instructions and commands, refer to the SCP Installation and ConfigurationGuide.

StepsAdministrator privileges are required to perform the following steps.

Copy SCP Service (sntlcloudps_[vendor_alias].exe) and SCP configuration file (sntlcloudp_configuration_[vendor_alias].xml) on the same system where the RMS LicenseManager is installed.

If you want to place SCP executable and configuration files at different locations, you can provide the configuration filepath in the SCP_CONFIG_FILEPATH_[vendor_alias] environment variable, or as a command-line parameter.

Note:In names given above, [vendor_alias] represents the vendor name registered with Gemalto.Say, its value is “alice” for a vendor. The names will be like:sntlcloudps_alice.exe (SCP Service), sntlcloudp_configuration_alice.xml (configuration file),and SCP_CONFIG_FILEPATH_alice (environment variable).

Open the command prompt and run any of the following commands to install SCP service:sntlcloudps_[vendor_alias].exe –install


To verify the SCP installation, open services manager (Run > services.msc), and check theSentinel Cloud PluginService For [vendor_alias] entry in the list of the services installed on the system.

Logging-related Notes

You need to un-comment the following section in the SCP configuration file to enable logging.

The logging will be enabled in the error mode, that you can change as required. The log file (.log) is created at the samelocation where SCP executable (for network applications) is placed.

Steps after SCP Installation and ConfigurationYouwill need to update the customer ID and YPS address in the SCP configuration file. These will be covered in thelater sections of this guide.

You will need to start the SCP services in order to retrieve licenses from SCC. Steps are given in the section Start SCPand the Sentinel RMS LicenseManager.

Before starting SCP:

• An entitlement should be created for customer, and

• The fingerprint of themachine on which the RMS LicenseManager is installed should be registered with SCC.

When SCP sends a license request to SCC, licenses are retrieved only if the fingerprint of the RMS LicenseManagerhost is registered with the customer in SCC and an entitlement is available for it in EMS.

The entitlement creation andmachine registration processes are detailed in subsequent sections.

Deployment SummaryHere is a summary of the overall deployment environment:

• A vendor purchases SCL. Gemalto generates a unique Vendor ID for the vendor, along with a set of secrets, calledSecret Key and Secret Key ID.

• A back-end environment is set up for the vendor in the public cloud. Gemalto provides the address of DirectoryServices (also known as YPS).

• EMS is installed and configured, in either the public cloud or in a vendor environment. Gemalto provides the EMSURL and login credentials (for “admin” user).

• The RMS SDK is installed by the vendor.

• The Sentinel RMS LicenseManager and SCP are installed and configured within the premises of the vendor’scustomer. The RMS LicenseManager is installed on DMZ. The IP address of themachine on which the LicenseManager is installed is available to the clients in a network.

Following items are available after the deployment has been prepared:

• Vendor ID, Vendor Alias, Secret Key, Secret Key ID

• YPSAddress


• EMS URL and login Credentials

• The RMS LicenseManager port


Tasks

In the next chapters, you will perform the following tasks (in the given sequence) assuming different user roles:

Define Features, Products, and Licensing Terms as vendor’s product manager, which includes the following steps:

Provision Entitlements as vendor’s order taker, which includes the following steps:

Register Machine as vendor’s customermanaging the RMS LicenseManager. It includes the following steps:

Retrieve and Consume Leased Licenses as vendor’s customer using the licensed application, where following tasksare done in iterativemanner:

View Billing Data and Usage Reports as vendor’s product manager or business analyst:

Note: The EMS procedures given in this guide cover only themandatory instructions requiredto complete a task. For a detailed set of instructions, please refer to the Sentinel EMS User’sGuide.


Define Features, Products, and LicensingTerms

A feature is an identifiable functionality of a software application that can be independently licensed. This can be anentire application, or a specific functionality, such as Addition, Subtraction, or Exponential.

A product is a licensing entity that represents one of the vendor’s marketable software offering. A product contains oneor more features.

A licensemodel is associated with each feature in a product. A licensemodel defines the license terms that govern howthe feature can be used, such as duration, number of users, standalone or network deployment, etc.

Features and products are typically defined by the Product Manager based on business decisions.

In this chapter, you use EMS to define features of the Calculator application, associate the Flexible licensemodel withfeatures, and create products.

Launch Sentinel EMSPoint your web browser to the EMS URL received in the Sentinel Services order emails, and log in. The default username is admin. The password is also received in the emails.

The EMS Home screen is displayed.

Create NamespaceA namespace can be used to identify a specific department or business unit of the vendor. In this section, you define anamespace:

To define the Demo namespace:

1. On the Sentinel EMS screen, click Catalog > Namespace > New. The Add Namespace screen is displayed.

2. In theNamespace field, typeDemo.

3. Click Save. TheAdd Namespace screen closes and the Demo namespace is displayed in themain pane of theNamespaces screen.

Flexible License Model OverviewTo create cloud-leased licenses, you use the Flexible licensemodel in EMS, which is a built-in licensemodel used forcreating a license lease policy for a feature. It provides a wide range of license attributes using which you canimplement almost any type of license policy. You can either use the Flexible licensemodel with default values, or youcan customize the values to create a new licensemodel.


Define Features, Products, and Licensing Terms

To view the Flexible licensemodel, click Catalog > LicenseModel to open the LicenseModel screen. A list ofavailable licensemodels is displayed. Select Flexible License Model in the left pane to view its attributes and defaultvalues.

Figure: The Flexible License Model



License Terms Used in the Current ExampleThe current example requires implementing subscription, floating, leased license policy for use in a networkenvironment, in the Cloud Served - Leasemode. The default Flexible licensemodel serves the purpose, as explainedbelow.

• Subscription: TheStart Date andEnd Date specify the subscription period. The default is 1 year.

• Floating: TheUser Limit controls themaximum number of users who can access a feature at a given time. Thedefault is 100.

• Lease: The License Deployment Type is selected as Cloud Servedwhich is required to offer the leasedlicenses. The behavior of the leased licenses in occasionally disconnected environment is controlled with the helpof the following attributes:

n Duration (In hrs): Specifies the duration of the lease. For this duration, the RMS LicenseManagercan remain disconnected from SCC. The default is 2160 hours.

n Renew frequency (In hrs): Specifies the time after which the client machinemust connect to theRMS LicenseManager to renew the lease. The default is 24 hours.

n Collect Usage: Specifies whether or not the client node collects usage data for reporting andbilling. This is selected by default.

n Usage Sync Frequency (In hrs): Time after which the usage data collected by the client machineis synced with SCC. The default is 24 hours.

• Network: The License Typemust be set toNetwork since licenses aremeant to be shared by multiple users in anenterprise network.

• Locking: The leased licenses are always node-locked. By default, locking is based onDisk ID.

At this moment, proceed with the defaults. The attributes values can bemodified later during the entitlement creation.

Note: If you want to specify different attribute values, click Copy. The Add LicenseModeldialog box is displayed, where you can specify a name for the licensemodel (theNew LicenseModel Name field), set the values as desired, and click Save.

Define FeaturesAssuming a product manager role, you need to define features in EMS. In this section, you define a feature that youwant to license for the Calculator application.

To define the Addition feature:

1. On the Sentinel EMS screen, click Catalog > Feature > New. The Create New Feature screen is displayed.

2. From theNamespace drop-down, select Demo.

3. In the Feature Name field, type Addition.

4. In the Feature ID field, type 10.

5. Under the License Models Available section, in theEnforcement field, select Sentinel RMS 9.1.

6. Select the Flexible licensemodel and click the right arrow. The selected licensemodel is added to the LicenseModel Associated list.



7. Click Save. The Create New Feature screen closes and the Addition feature you defined is displayed in themainpane of the Features screen.

Similarly define other features for the Calculator application, by using the following values.

Feature Name Subtraction Exponential Logarithm

Feature ID 11 12 13

Enforcement Sentinel RMS 9.1 Sentinel RMS 9.1 Sentinel RMS 9.1

LicenseModel Associated Flexible Flexible Flexible

Define ProductsNext, you package the features created above into different products for the Calculator application. The products youdefine are:

• Basic: Allows access to only Addition and Subtraction features.

• Advanced: A full-featured product that allows access to all features.

To create the Basic product:

1. On the Sentinel EMS screen, click Catalog > Product > New. The Create New Product screen is displayed.

2. From theNamespace drop-down, select Demo.

3. In theProduct Name field, type Basic.

4. In theVersion field, type 1.0.

5. Under theAvailable section, select Addition and Subtraction features and click the right arrow. The selectedfeatures are added to the Features Associated list.

6. Click Save. The Create New Product screen closes and the Basic product you defined is displayed in themainpane of the Products screen.

7. Click Complete. This changes the product's Lifecycle Stage to Complete, andmakes the product available fordistribution.

Similarly, create the Scientific 1.0 product by selecting all the features (Addition, Subtraction, Logarithmic, andExponential) shown in the Features Available section.

What’s Next?You have defined features and products in EMS. Now, you are ready to take customer orders and create entitlementsfor them by including products that you have defined.


Provision Entitlements

In this section, you create entitlements and configure product’s license terms. You also define the customer for whomthe entitlement is provisioned.

Define CustomerIn this section, you define a customer of the Calculator application, for whom entitlements will be created in thesubsequent section. While creating customer, a contact e-mail is also specified for the contact person who will receiveentitlement related notifications.

To create the XYZ Accounting customer:

1. On the Sentinel EMS screen, click Customers > New. The Create Customer screen is displayed.

2. In theCustomer Name field, type XYZ Accounting.

3. In theCustomer ID field, type XYZ_Accounting. (The Customer ID is auto-generated, if a value is not provided.)

4. Ensure that Enabled andCreate contact check boxes are selected.

5. Under theContact Details section, in theE-mail field, type [email protected].

6. Ensure that the Login Allowed check box is selected.

7. Specify a password of your choice in thePassword andConfirm Password fields.

8. Click Save. The Create Customer screen closes and the details of the customer you defined are displayed in theCustomers screen.

Create EntitlementIn this section, you create an entitlement for a customer by completing the following steps:

To create an entitlement:

1. On the Sentinel EMS screen, click Entitlements > New. The Entitlements screen is displayed.

2. In theCustomer Name field, type XYZ, and select XYZ Accounting from the list of customers that appears. TheContact E-mail is displayed automatically.

3. Keep the default forStart Datewhich shows the current date.

4. In theEnd Date field, clear theNever Expires check box, and specify a date one year after the current date.


mailto:[email protected]


5. Click Add Product. A screen is displayed showing the products you created (see Define Products), under theSelect Product section.

6. Select Basic 1.0 and click Add to include the product in the entitlement. The Configure Product screen isdisplayed showing details and features of the selected product.

7. Under the Feature Selection and LicenseModel Configuration section, ensure that the check boxes given beforeAddition and Subtraction features are selected, and click Configure Selected License Models. The ConfigureLicenseModel pane is displayed, where you can configure the license terms as described below:

a. From the License Type drop-down, select Network. .

b. Under the License Duration section, select theStart from activation date check box. Keep default for theLicense Duration (in days) field, which is 365 days. This creates a subscription license which remains validfor a year from the date of activation.

c. Expand the Limits section. In theUser Limit field, erase the default value and enter 10. This creates a 10-seatlicense.

d. Expand the Lease section. Ensure that License Deployment Type is selected as Cloud Served.

e. Click Save to return to the previous screen.

Note: These license terms were introduced in the section Understanding the “Flexible” LicenseModel. The values were not changed at that moment, so that they can be changed at this stageof order processing.

8. Under the Feature Selection and LicenseModel Configuration section, ensure to include all features. A dialog boxappears to confirm if you want to use the same data in all other rows. Click Yes to switch on all the features.

9. In theQuantity field, type 10. This specifies the number of the RMS LicenseManager hosts where the licensescan be deployed.

10. Click Next. The Licensing and Custom Attributes screen is displayed. Keep the defaults, and click OK. The nextscreen displays entitlement details you specified above, such as customer name, selected product, features, andlicense attributes.

11. Under theEnforcement Extension section, specify/ensure the following:

a. Duration (hrs): Type 720 to issue a lease for approximately 30 days.

b. Renew frequency (hrs): Keep the default value, 24, to indicate that lease should be renewed every day.

c. Usage Sync Frequency (hrs): Keep the default value, 24, to enable SCC to collect the usage data every day.

Note: The usage sync frequency defines the time interval at which usage data is sent from endcustomer site to the cloud. By default, frequency is 24 hours and range is from 1 hour to 438000hours (50 years).

12. Click Save.

13. Click Commit. A dialog box appears to confirm if you want to commit. Click Yes.

This creates the entitlement for a customer, and stores details in EMS database. An entitlement certificate e-mail issent at the given contact e-mail ([email protected]) of the XYZ Accounting customer.



Activate EntitlementActivation is required to deploy the entitlement on SCC so that it can be accessed by customers.

After you activate an entitlement, licenses are generated from the entitlement, and license details are sent from EMS toSCC database. An e-mail containing license details is also sent to customer’s contact.

1. Open theEntitlements screen and select the entitlement you created in the above section.

2. Under the Associated Product and Features section, select the check box present before Basic 1.0 product.

3. Click Activate. The Deploy Product screen is displayed.

4. Click Deploy.The licenses are generated in theQuantity defined during entitlement creation, and pushed to SCC database. An e-mail is also sent to the designated contacts of the customer. This e-mail contains EID and login credentials, byusing which the contacts can login to EMS Customer portal and register their machines.

5. The next screen shows the entitlement and product details. Click OK to close the screen.


Register Machine

Themachine on which the RMS LicenseManager is installedmust be registered with an entitlement of customer to getlicenses from SCC. The fingerprint of the LicenseManager host machine is extracted and then registered with acustomer’s entitlement by using EMS.

Figure: The machine registration process

(Registration results in a binding between customer, entitlement, andmachine fingerprint)

Extract Fingerprint of the RMS License Manager (byCustomer)A custom tool is given by the vendor to customers for extracting the fingerprint of the RMS LicenseManager. The toolshould be designed to fetch themachine fingerprint with the help of the sntl_licensing_get_info API. The output of thetool is an .xml file containing the fingerprint details.

The customer sends the extracted fingerprint XML to the vendor. This can be donemanually (by e-mail), or by tuning thetool to send the fingerprint automatically.


Register Machine

Register Fingerprint with Customer’s Entitlement (byVendor)The vendor receives the fingerprint XML from the customer, and uses EMS to register the fingerprint with a givenentitlement of a customer.

To register the fingerprint of the RMS LicenseManager by using the vendor portal:

1. Copy the fingerprint XML (received from customer) to your system.

2. Open theEntitlements screen and select the entitlement you created in the section above.

3. Click Fingerprint. The Fingerprint Management dialog box is displayed.

4. In the Fingerprint Friendly Name field, specify the host name of the RMS LicenseManager machine. TypeRMSLM.

5. Click Choose File and browse to the location where the Fingerprint XML is placed.

6. Click Register.


Retrieve and Consume Leased Licenses

When SCP starts on the RMS LicenseManager, it connects to DS and gets the URL of SCC node. Next, a connectionis made to SCC and licenses are automatically obtained to the RMS LicenseManager from the customer’s entitlementprovisioned on SCC.

The LicenseManager provides these licenses to clients, in the same network, on demand for running the vendorapplication.

PrerequisitesThere are certain conditions that must bemet for the successful retrieval of licenses to the RMS LicenseManager:

• An entitlement should be activated for the customer, and the RMS LicenseManager fingerprint should beregistered. In the current scenario, the entitlement for the XYZ Accounting customer has been activated (seeActivate Entitlement), and the fingerprint of the RMS LicenseManager has been registered (see RegisterFingerprint with Customer’s Entitlement).

• Customer ID should be updated in the SCP configuration file (see Specify Customer ID in SCP Configuration File).

• The YPS address should be updated in the SCP configuration file (see Specify YPS Address in SCP ConfigurationFile).

• The RMS LicenseManager and SCP services must be running (see "Specify YPS Address in SCP ConfigurationFile" on the next page).

Specify Customer ID in SCP Configuration FileOpen the entitlement certificate email corresponding to the entitlement for which you need licenses. Copy the customerID and specify it in the SCP configuration file.



<Customer id=" XYZ_Accounting"/>

Specify YPS Address in SCP Configuration FileThe Sentinel Service order emails from Gemalto contain the YPS URL for development and production environments.Copy the required YPS URL and specify it in the SCP configuration file.

<YPSaddress value="https://qa-he.test.sentinelcloud.com/YPServer" />

Start SCP and the RMS License ManagerStart the RMS LicenseManager and SCP services. You can do this manually by using theWindows ServicesManager. Alternatively, you can use the following commands:

To start the RMS LicenseManager:lservnt.exe –X startTo start the SCP service:sntlcloudps_[vendor_alias].exe –start

Note:If SCP is already running, licenses are fetched at a frequency defined in the entitlement in theRenew frequency field (see Create Entitlement)The steps covered are forWindows only.

View the lservrc License FileWhile SCP is running on the RMS LicenseManager it acquires leased licenses from SCC. The file in which licensesare stored is called license file (lservrc).

Once licenses are acquired, the lservrc license file is created at the same location where the RMS LicenseManager isinstalled.

Let us say that the RMS LicenseManager is installed at C:\RMSServer_860_44. The license file will be present at thesame location.



Note: If the lservrc file is not encrypted, you can open it in Notepad and read its contents tohave an idea of how the license string looks like. Usually, the file is kept encrypted to ensureits security.

Run the ApplicationTo consume the license, run the Calculator application and use the Addition feature.

At the application level, using the Addition featuremeans a login call for the feature has been executed. Since thelicense is available, the login call should execute successfully and you should be able to use the Addition feature.

The application has the contactServer RMS API implemented in it that allows the client to locate the RMS LicenseManager. This API specifies the name of the LicenseManager host for communication.

Note: In this case, to keep the procedure simple, the application and the RMS LicenseManager are running on the samemachine. However, you can execute the application on any ofthe clients in the network.

Use the WlmAdmin Utility to View License Details(Windows)TheWlmAdmin is a Sentinel RMS utility available forWindows platform that provides detailed information related to theRMS LicenseManager (such as host name and IP address) and licenses (such as their availability and clients usingthem). WlmAdmin is meant for monitoring the feature usage and licensing activity of applications licensed usingSentinel RMS.

Let us use this utility to verify that one license has been consumed for the Addition feature.

Name and Location

The utility is available by the nameWlmAdmin.exe. The exact location of this utility depends on your applicationvendor.

Steps:

To runWlmAdmin, useWindows Explorer to navigate to the location of the WlmAdmin.exe file, and double-click the fileto start the program.



Note: You can run the utility on any machine in the network where the current RMS LicenseManager operates. It is not necessary to have the RMS LicenseManager installed on thissystem.

Expand the Defined Servers node in the left panel, to display the host names of available the LicenseManagers. Thehost name of the LicenseManager in the current scenario is LOCALHOST.

Note: The LicenseManager is detected automatically by WlmAdmin if the contactServer APIhas been implemented in the licensed application. However if not detected, you can add theLicenseManager manually. Click Edit > Defined Server List, type localhost in the Server field inthe displayed dialog box, and click Add.

Expand LOCALHOST to display features for which licenses are installed on the LicenseManager. It shows a node forthe Addition feature in the left panel.

Select and expand Addition to view the names of clients that are currently using the licenses for the Addition featurealong with the license list (Lic0, Lic1, etc.). In the right panel, under the Feature Information section, you can view thedetailed information of the selected Addition feature.

The In Use field shows 1 indicating that one license has been consumed for this feature (as explained in the abovesection). The Total column shows the total number of licenses available.

Figure: The WlmAdmin Utility Showing the License Activity

Formore details of theWlmAdmin utility, refer to the RMS System Administrator’s Guide.



View the Usage FileWhen the license for a feature is consumed, its usage data is collected by the RMS LicenseManager in usage files.These files contain entries for every feature login-logout; along with details of feature consumed such as customername, product name, feature name, version, start date, end date, etc.

Usage files are created on the RMS LicenseManager host (with the .udb extension) in the same directory where theLicenseManger is installed.

Notes:

• Usage files are created only when the Collect Usage option is kept enabled in the Flexible licensemodelassociated with a feature (see Understanding License Terms).

• Each file has a size limit of 5 MB (non-configurable) and when this limit is reached, a new file is created. Amaximum of 9999 files can be created on disk, after which the existing files are overwritten starting from the firstfile, if present.

About Syncing Usage with SCCThe SCP service, running on the RMS LicenseManager, pushes the usage data to SCC in the following events:

• When the licensed application starts or restarts.

• At a frequency specified in an entitlement, if the SCP service is already running. The renew frequency is used tosync licenses and the usage sync frequency is used to sync usage (see Create Entitlement).

• On calling the sntl_licensing_transfer_licenseRMS API with the sync action. For API details, refer to the SentinelRMS SDK API ReferenceGuide.

• On force refresh that is performed using the -fr or –rf command-line options of SCP. For details of the SCPcommand-line options, refer to the SCP Installation and Configuration Guide.

After usage file is sent to SCC, it is removed from the LicenseManager host.


View Billing Data and Usage Reports

SCC collects the usage data from the LicenseManager and aggregates it to providemeaningful information forgenerating bills and reports. You can view usage reports and (partially-processed) billing data by using EMS.

Previously in this guide, it was demonstrated how the Addition feature of Basic 1.0 product is consumed from anentitlement created for the XYZ Accounting customer. This section uses the same entitlement for viewing the variousreports.

Note:The billing data and usage reports are available only after the usage data has been collected bySCC and aggregated by DE.These details are not available immediately after the licensed application usage. Since usage issent to SCC periodically (as set by the Usage Sync Frequency) and aggregation also runs atdefined time intervals (configured by Gemalto), there will be a time delay.

View Usage Data and Billing DataTo view usage data for billing:

1. Open the Entitlements screen in EMS and select the entitlement that you created in the steps above (see CreateEntitlement). You can search the entitlement based on EID, customer name, contact email, and various otherfields.

2. Under the Associated Product and Features section, select the Basic 1.0 product, and click Usage Bill. The BillingData dialog box is displayed.

3. Specify the duration for which you want to view the billing data and the bill type (brief, itemized, or detailed).

4. Click Submit. An XML file containing the billing data is downloaded to themachine.

Similarly, to view usage data for an entitlement, open the desired entitlement, select the Basic 1.0 product, and clickUsage Data. Specify the duration in the dialog box and click Submit. The usage data is displayed on the screen inHTML format.

View Usage ReportsEMS allows you to generate various types of usage reports.

To view the Feature Usage Report:


View Billing Data and Usage Reports

1. On the EMS Home screen, click Reports, and expand theUsage Reports section.

2. Click Feature Usage Reports.

3. Specify Start Date andEnd Date. Ensure that theOutput Format is selectedHTML. Click Generate Report. Thereport is displayed on the screen showing the details in graphical and tabular formats.


What’s Next?

Refer to the respective documentation of Sentinel EMS and Sentinel RMS to learnmore about the licensing andprovisioning aspects of SCL.


Support Contacts

You can contact us using any of the following options:

• Business Contacts: To find the nearest office or distributor, use the following URL:

https://sentinel.gemalto.com/contact-us-sm/

• Technical Support: To obtain assistance in using Gemalto Sentinel products, feel free to contact our TechnicalSupport team:

– Phone: 800-545-6608 (US toll free), +1-410-931-7520 (International)

– Regional Support Contact Information:

https://sentinel.gemalto.com/technical-support-sm/

– E-mail: [email protected]

– URL: https://sentinel.gemalto.com/technical-support-sm/

• Downloads: You can download installers and other updated components using this URL:



https://sentinel.gemalto.com/contact-us-sm/


mailto:[email protected]



scl tutorial- managing leased licenses in a network · 2019. 10. 14. · contents...

Documents