AutoPass License Server

The AutoPass License Server (APLS) helps you organize and manage ALM licenses, by providing better visibility and control over license consumption. This section describes how to install the license file and use the ALM AutoPass License Server.

Note: For more information about APLS, see AutoPass License Server.

Step 1: Install licenses

After installing and configuring the AutoPass License Server (see Installation and upgrade), you install your licenses in the AutoPass License Server. This step enables you to perform license management tasks.

  1. Open AutoPass.

  2. Install licenses.

    1. Upload the license file to the license server.
    2. In the License Management pane, click the Install License tab.

    3. Click Choose File to browse for and select a license key.

      The licenses are installed on the AutoPass License Server and are displayed in the View License tab.

Back to top

Step 2. View installed licenses

The View Licenses tab displays the information about all installed licenses and enables you to archive licenses.

  1. In the License Management pane, click the View Licenses tab.

  2. This tab displays the following details:

    Feature The feature and its version number.
    Product The product to which a feature belongs.
    Capacity The total installed capacity for each installed license.
    Start Date The starting date of the installed license.
    Expiry Date The expiration date of the installed license
    Installed On The installation date of the installed license.
    Installed By The name of the AutoPass License Server user that installed the licenses.
    Lock Code The license key installed can be locked to a lock value.
    Export to Excel Exports the currently displayed report to Excel.
    Export Raw License to Excel Exports the license keys for the currently displayed licenses to Excel.
    Archive Archives the selected license.

Back to top

Step 3: Apply Licenses

Apply the licenses for the product features in the Product Feature tab (Available from ALM 15.0.1.).

  1. Prerequisite: To display the Product Feature tab, you need to upload the 15.5 .pd file.

    1. From the ALM server machine, go to {ALM repository}\sa\DomsInfo\MaintenanceData\conf\autopass.
    1. Select a 15.5 .pd file.
    2. Copy the pd file to {autopass}\apls\licenseserver\data\conf\pdfiles.
    3. Restart the AutoPass service.

    4. Add the following parameters in the clusterSettings.properties file in {ALM repository}\sa\Admin\MaintenanceData\conf:

      • AUTOPASS_SERVER_PORT: Port number of the AutoPass server.

      • AUTOPASS_SERVER_NAME: AutoPass server name

      • AUTOPASS_SERVER_PROTOCOL: AutoPass server protocol

    5. Restart ALM server.

  2. Prerequisite: If you are planning to use multiple licenses, you must first install them using the Install License tab. You then apply all of them at once in the Product Feature tab.
  3. In the License Management pane, click the Product Feature tab.

  4. This tab displays the following details:

    Select Product The product name.
    Feature The feature and its version number.
    Product Number The SKU number of the product.
    LTU (License To Use) The number of purchased SKUs.
    Capacity The total capacity of the purchased SKU.
    Start Date The starting date of the installed license.
    Expiry Date The expiration date of the installed license
    Installed On The installation date of the installed license.
    Installed By The name of the AutoPass License Server user that installed the licenses.
    Lock Code The license key installed can be locked to a lock value.
    Status Indicates whether the license has been applied.
    Export to Excel Exports the currently displayed report to Excel.
    Export Raw License to Excel Exports the license keys for the currently displayed licenses to Excel.
    Archive Archives the selected license.
    Apply

    Applies and installs all the product features.

    The Status field changes to Applied.
  5. Select the product. The list of features are displayed.

  6. Click Apply. The Product Features dialog box opens. Click Install.

    After applying the licenses on the AutoPass License Server, they can only be viewed from the Product Feature tab. They are no longer displayed in the View Licenses tab.

Back to top

Create a license pool

You can create pools to organize and maintain client users in any number of ways: users of a specific feature, users of a specific product, users with common attributes, and so on. Client users can be assigned to multiple user pools.

  1. In the Reservation Management pane, click the Pool Management tab.
  2. Click Create Pool.

  3. In the Create New Pool dialog box, enter a name and description for the user pool. Click Create.

    The user pool is displayed in the user pool list in the Pool Management tab.

Back to top

Assign project or domain to a pool

In order for client users to access and check out licenses, each client user has to be assigned to a pool. Depending on the user's details and settings, the AutoPass License Server finds and checks out an appropriate license for the client user.

  1. In the Pool Management tab, select the radio button for the pool to which you want to add client users. The lower pane displays the selected pool name.

  2. To assign a domain: Create a pool using the same name as the domain name in Site Administration.

  3. To assign a project: In the lower pane, select Client ID. Enter the client ID (Domain name/project name).

    Note:  

    • You can add multiple client IDs in one pool.
    • Domain name and project name must be identical to names used in ALM.
  4. Click Add. The user's details are displayed in the Associated Users area of the lower pane.

Back to top

Reserve feature license capacity to a pool

After creating pools, you can reserve a certain amount of license capacity to each pool. This is done in the Feature-Based and Product-Based Reservation tabs. For example, if you want a client user to have access only to specific environments or configurations in ALM, you reserve licenses using feature-based reservation. If you want a client user to have access to all ALM features, use product-based reservation.

  1. In the Reservation Management pane, select the Feature-Based Reservation tab.

  2. Select ALM from the drop-down menu.

  3. In the feature table, select the radio button for the feature for which you want to reserve capacity. Click Manage.

  4. Click Associate Pool in the Feature-Based Reservation tab, select your pool and click Associate Pool.

  5. Enter reserved capacity for the associated pool.

Back to top

View license usage report

The License Usage pane displays information about the list of all installed license details, including:

  • The feature license identification information, including number and description.
  • The available license capacity.
  • The capacity currently checked out as live and commuter licenses.
  1. In the Usage Reports pane, select the License Usage tab.

  2. The tab displays the following details:

    Feature ID: Version

    The specific feature number and version for each feature of the selected product in the drop-down.

    Click a feature number to see the usage details of this feature.
    Feature Description A textual description of a feature.
    Available The license capacity currently available for a client user to check out.
    Live The license capacity currently checked out as live, concurrent licenses.
    Commuter/Usage The license capacity currently checked out as commuter licenses.
    Total The total installed license capacity.
    License Capacity The reserved license capacity.
    Manage Commuter Enables you to modify the commuter check out settings for a feature, if enabled.

Back to top