Assign Aternity License Units to End User Devices (License Provisioning)

Use License Provisioning to allocate license units to any combination of types of end user devices where you want to monitor their performance in Aternity. Aternity automatically allocates license units whenever a device requests to report its performance. You can also add new licenses, reserve a license for a specific user or device, and set limits for each type of device.

For example, if you purchase 1000 license units, use License Provisioning to limit up to 500 monitored mobile devices, or manually allocate specific hostnames or usernames to guarantee that they can always monitor their performance.

Tip

To calculate the number of license units you need, use the License Calculator (learn more).

By default, Aternity reserves your manually allocated licenses, then automatically grants requests from any device type until it reaches the total licenses allowed. You can also limit the number of licenses for each type of device. For example, if you purchase 1000 license units, you can set a limit of up to 300 B2E mobile devices.

Manually allocate a license, or allow Aternity to automatically allocate from the available licenses
Note

After manually or automatically allocating license units to end user devices, they remain occupied until the user/device stops reporting to Aternity for 14 consecutive days (non configurable). After that, Aternity automatically releases the license, making it available for another user/device.

If a device stops reporting to Aternity for any reason, including unavailable licenses, you can continue viewing its data by setting the dashboard's timeframe to cover its active reporting, but its status shows as Disconnected.

If you release a device, it tries to reconnect immediately with an available license. However, if none are available, it waits eight hours before trying again to connect. You can configure this by selecting the Gear Icon > agent > httpagent > backOffIntervalInMinutes.

Procedure

  1. Step 1 Open a browser and sign in to Aternity.
  2. Step 2 Select the Gear Icon > License Provisioning.
    License Provisioning page
    Tip

    To assign license units to a backend server, contact Customer Services.

    Type Units Description
    Physical devices

    1 unit

    This license monitors the performance of a single end user device by deploying the Agent for End User Devices locally, which reports metrics to Aternity. It can be Windows or Mac, as a laptop, desktop, or surface PC. It requires a single license unit.

    Monitor physical end user devices with the Agent for End User Devices locally
    Virtual desktop users (VDI)

    1 unit per username

    This license reports the performance inside a single end user virtual desktop (VDI) to Aternity, where the VDI desktop image contains the Agent for End User Devices. All VDI sessions for a single user require one license unit.

    Embed the Agent for End User Devices in a virtual desktop image to monitor its performance
    Virtual app sessions

    ¼ unit per session (or one unit for four sessions)

    This license reports the performance of a frontline end user virtual app session to Aternity. Deploy the Agent for End User Devices on a virtual app server like Citrix XenApp. Each named user running one or more monitored sessions requires a quarter (¼) of a license unit.

    (From Agent 11) To monitor virtual app sessions (not VDI), you must also add the Virtual App Servers license (five units) to connect to this server.

    Monitor activities in virtual apps
    Virtual app servers (from Agent 11 only)

    5 units per server

    (From Agent 11 only) This license reports the resource usage and latency of a Citrix XenApp server as a whole to Aternity. Deploy the Agent for End User Devices on a XenApp server, where each server requires five license units.

    Monitor virtual app server resources

    At the top of the screen it displays the current license status in your deployment, and the number of license units assigned per device type:

    Field Description
    Total Licenses

    Displays the total number of license units of all types which are available before any are allocated.

    Tip

    Your organization may be in the phase of gradually rolling out licenses. This is a normal part of license deployment, as more licenses are made available for allocation over time. Contact Aternity SaaS Administration if you need more licenses for allocation immediately.

    Gradual rollout of licenses
    Currently In Use

    Displays the total number of occupied licenses units, and the percentage of this number out of the Total Licenses.

    Rejected in the Last 24 Hours in the heading, or Rejects (Last 24 Hours) column

    Displays the number of times Aternity rejected a device's request for a license during the past 24 hours. To troubleshoot individual rejections and their reasons, select Provisioning Events (learn more).

    Limit

    If you already defined a limit, it displays the maximum number of license units available for allocation for this type of device, within the total number of units available.

    Currently In Use

    Displays the number of units currently occupied by devices of this type. If you defined a limit, it displays its percentage out of the limit imposed for this device type.

  3. Step 3 To limit the number of devices reporting to Aternity for each type of device, select Edit Limits.

    Select Limited To to enter the maximum number of reporting devices or sessions allowed for devices of this type.

    Define a limit for each type of license
    Field Description
    Total Licenses

    Displays the total number of license units of all types which are available before any are allocated.

    Tip

    Your organization may be in the phase of gradually rolling out licenses. This is a normal part of license deployment, as more licenses are made available for allocation over time. Contact Aternity SaaS Administration if you need more licenses for allocation immediately.

    Gradual rollout of licenses
    Deployment License Limit

    (Aternity on-premise administrators only) Enter the maximum number of licenses you wish to deploy.

    If this value is less than the total purchased, Aternity displays that you are in the phase of Gradual Rollout of Licenses.

    Limited to

    Select this to set the maximum number of reporting devices or sessions for this type of license.

    Remember to multiply the licenses by four to find the maximum number of virtual app sessions.

  4. Step 4 To manually allocate a license to a username, hostname or device ID, select the type of license in the License Type column, then select Manual Allocation.
    Note

    After manually or automatically allocating license units to end user devices, they remain occupied until the user/device stops reporting to Aternity for 14 consecutive days (non configurable). After that, Aternity automatically releases the license, making it available for another user/device.

    Manually assigning a named license
    Field Description
    Device Name (for a physical device)

    Enter a device hostname to reserve a license for a physical Windows laptop or desktop.

    Device ID (for a mobile device)

    Enter a device ID to reserve a license for a physical mobile device running a monitored mobile app.

    User Name (for virtual devices or virtual app sessions)

    Enter a username for a license to monitor a virtual application session or virtual desktop (VDI) session.

    Alternatively, to specify several devices/users at once, create a CSV file containing a single column which lists all the hostnames (or usernames for virtual sessions) which you want to allocate. Then select Bulk Allocation to upload it to Aternity.

  5. Step 5 To release all occupied licenses from one or more device types, select those rows, then select Release Licenses.

    For example, if there are no more available license units, and you know there are users or devices which occupy a license needlessly as part of their 14 day grace period, you can release all license units of that device type, to allow other devices to be assigned to an available unit to report their performance.

    If you release a device, it tries to reconnect immediately with an available license. However, if none are available, it waits eight hours before trying again to connect. You can configure this by selecting the Gear Icon > agent > httpagent > backOffIntervalInMinutes.

    Release all the occupied licenses of one type
  6. Step 6 To release a specific manually allocated license, select the type of device, select the device/user to release, and select Release Licenses.

    Use the search box in the top right corner to jump to a specific username or device.

    If you release a device, it tries to reconnect immediately with an available license. However, if none are available, it waits eight hours before trying again to connect. You can configure this by selecting the Gear Icon > agent > httpagent > backOffIntervalInMinutes.

    Freeing a specific license
  7. Step 7 To add a new Serial Number to Aternity if it is not yet added or if you purchased new license units, do the following:
    1. a Login as administrator and select the Gear Icon > License Provisioning.
    2. b Select Licenses.

      You can see your licenses and all related data. Once selected, Aternity starts checking against the Licensing Management System if this serial number is valid and not in use in another account. Once finished, you get the summary of the licenses.

      You can also add a new license if you received a new serial number.

    3. c Select Add Serial Number.
    4. d Enter the serial number and select Validate.
      Add new serial number (license key) to Aternity

      Aternity checks against the Licensing Management System if this serial number is valid, not in use in another account, and so on, and when finished, the summary of the license is displayed.

      Adding the same serial number to multiple accounts or several times is not allowed. If the serial number is already in use, you will be notified and prompted to enter a valid number.

    5. e Once validated, select Add.

      The License Provisioning screen shows an updated list of total licenses.

      See a new row with a new serial number that was added to the list of all licenses

      The system refreshes every 24 hours. Any automatic update performed by Aternity SaaS Administration will be shown after a refresh. You can manually refresh the system If you know about an automatic update, but cannot wait 24 hours.

      Note
      If your account license expires soon, you will see the icon on the top of the main screen that reminds you about the expiration date and allows adding the serial number on time. If you missed it, no worries. There is a 30 day grace period when you still can re-add your license. You will see the notification about it on the top of the main screen.
      Make sure to renew your license on time
  8. Step 8 To troubleshoot why Aternity does not monitor a device, to determine if it did not receive a license and why, select Provisioning Events.

    View the recent licensing events, where each entry shows only the latest event for that user or device. To jump to a specific hostname, device ID or username, enter it in the search box on the top right of the screen.

    Tip

    You can also extract this information in Aternity's REST APIs, using the LICENSING_EVENTS API. Learn more.

    Log of provisioning events for automatic and manual allocation
    Field Description
    Last occurred at

    Displays the time and date when the last licensing-related event took place for this user or device.

    Name / ID

    Displays the username (virtual session), hostname (computer) or device ID (mobile) which requested the license units.

    License Type

    Displays the type of license for this event.

    Event Type

    Displays Aternity's response to the request for license units. The possible choices are: Approved or Rejected.

    Details

    Displays the reason for the rejection of a license request. The choices are:

    • No license available indicates that Aternity already reached its full quota of (all types of) license units. Contact Customer Services to purchase more licenses.

    • License type limit reached indicates that you reached the maximum limit on the number of units allowed for this type of device. To resolve, either change the limits for this type of device, or purchase new units.

    • Deployment license limit reached indicates that you have reached the temporary limit of your gradual rollout of license units. Contact Aternity SaaS Administration to increase the rollout to allow further allocation of units.

    • Monitored session limit exceeded indicates that Aternity already assigned the maximum number of virtual sessions for that server. By default you can have up to 50 simultaneous monitored sessions on a single virtual application server.

    License Used

    Displays whether the requested license was indeed occupied as a result of this event.

    Serving Hostname

    (For virtual sessions only) In CItrix XenApp sessions, it displays the hostname of the XenApp server. For VDI sessions, it displays the hostname of the virtual desktop used in this session.