Register licenses

After installing and setting up your On-Prem Qt License Server instance, you need to register the licenses you want to use from your Qt Account. You can register licenses as the license manager, administrator, or deputy license manager. You can edit the users of a license in Qt Customer Portal. For more information, see Assign roles.

After the licenses are registered, the On-Prem Qt License Server instance syncs licenses from the Qt cloud regularly. If the host computer or the On-Prem Qt License Server instance is restarted for any reason, the previously registered licenses are automatically re-registered by the instance.

For the rules that apply to registrations and example scenarios with one or several license managers, see License registration rules and License registration example scenarios.

Prerequisites

Before you register licenses for your On-Prem Qt License Server instance, ensure that:

• You have valid pool or floating licenses in your Qt Account.
• Your On-Prem Qt License Server instance is set up and running.
• You know the URL of your On-Prem Qt License Server instance.

Optionally, you can set up environment variables for your Qt Account credentials instead of using the --email and --password options:

• QLS_QT_ACCOUNT_LOGIN_EMAIL
• QLS_QT_ACCOUNT_LOGIN_PASSWORD

Register all licenses

To implicitly register all applicable licenses in the given Qt Account for your On-Prem Qt License Server instance, run:

qt-license-server register --email <email> --password <pass> --url <instance URL>

qt-license-server.exe register --email <email> --password <pass> --url <instance URL>

Then, review the changes and confirm your action when prompted to proceed. To bypass the confirmation prompt, add the --force option to the command.

Register specific licenses

To explicitly register only specific licenses in the given Qt Account with a license ID, run:

qt-license-server register --email <email> --password <pass> --url <instance URL> --licenses <license number1> <license number2>

qt-license-server.exe register --email <email> --password <pass> --url <instance URL> --licenses <license number 1> <license number 2>

Then, review the changes and confirm your action when prompted to proceed. To bypass the confirmation prompt, add the --force option to the command.

Validate registered licenses

To verify the currently registered licenses with your On-Prem Qt License Server instance, run:

./qt-license-server status --url <URL>

.\qt-license-server.exe status --url <URL>

In case the registered licenses are not updated as expected, check the logs. Contact Qt Support if the issue persists.

License registration rules

The main rules for license registrations are:

• Licenses can be registered implicitly (without specifying license numbers) or explicitly (by specifying the license numbers).
• Initial registration can be done implicitly or explicitly.
• Once the On-Prem Qt License Server instance has licenses registered, you can continue registrations only by explicitly giving the license numbers.
• Multiple users can manage license registrations on the same On-Prem Qt License Server instance if they have the appropriate roles.
• If a license registration or deregistration fails for any reason, the current state is always preserved.

Automatic license synchronization

On-Prem Qt License Server automatically synchronizes registered licenses with the Qt cloud hourly and at startup.

During synchronization, the following actions are performed:

• Each registered license is validated against the Qt cloud service.
• Expired, revoked, or invalid licenses are automatically removed.
• Licenses with uncertain status (due to network or server errors) are retained until their status can be confirmed.
• Valid licenses are retained and updated.

License registration example scenarios

This section's example scenarios illustrate how to manage license registrations.

Single user On-Prem Qt License Server license registration administration

In this example scenario, only one user manages the on-prem instance license registrations.

1. User 1, the license manager, does the initial license registration implicitly. User 1 runs the command:

   ./qt-license-server register -e example.user@company.com -p 1234567890 --url https://my.company.onprem.address:8080

   The output shows the licenses registered successfully:

   Licenses registered successfully.
   License: 11554731 | Owner: Example User | Seat amount: 20

2. User 1 purchased new licenses and wants to register them as well, in addition to existing registrations. User 1 forgets to explicitly define the license numbers, which is required after the initial registration. User 1 runs the command:

   ./qt-license-server register -e example.user@company.com -p 1234567890 --url https://my.company.onprem.address:8080

   The output notifies User 1 about the error:

   Error: Server is already hosting registered licenses: [11554731]
   
   To update registration, you must explicitly specify licenses using -l/--licenses.
   This safety check prevents accidental changes to your license registration.
   
   *** Note: You might be removing licenses, which this account, example.user@company.com, does not have rights to! ***

3. User 1 registers the new licenses explicitly by specifying the license numbers. User 1 runs the command:

   ./qt-license-server register -e example.user@company.com -p 1234567890 --url https://my.company.onprem.address:8080 -l 11554731 96023021

   The output shows a summary of the changes and requests confirmation before proceeding:

   Registration Change Summary:
   Currently registered licenses: [11554731]
   Requested licenses:            [11554731, 96023021]
   
   Licenses to be added:   96023021
   
   ? Are you sure you want to proceed with these changes?

   User 1 confirms by answering Yes, and the output shows:

   Licenses registered successfully.
   License: 11554731 | Owner: Example User | Seat amount: 20
   License: 96023021 | Owner: Example User | Seat amount: 3

Shared On-Prem Qt License Server license registration administration

In this example scenario, three users manage the license registrations and deregistrations on the same On-Prem Qt License Server instance.

1. User 1, the license manager, does the initial license registration implicitly. User 1 runs the command:

   ./qt-license-server register -e example.user1@company.com -p 1111111111 --url https://my.onprem.instance.addr:8080

   The output shows the licenses registered successfully:

   Licenses registered successfully.
   License: 11554731 | Owner: Example User 1 | Seat amount: 20

2. User 1 grants the Deputy license manager role to User 2 and User 3 in Qt Customer Portal. Now they can take over the On-Prem Qt License Server instance license registration management.
3. User 2, a deputy license manager, takes over the On-Prem Qt License Server instance and wants to add another license, in addition to the existing ones. User 2 runs the command:

   ./qt-license-server register -e example.user2@company.com -p 2222222222 --url https://my.onprem.instance.addr:8080 -l 11554731 96023021

   The output shows a summary of the changes and requests confirmation before proceeding:

   Registration Change Summary:
   Currently registered licenses: [11554731]
   Requested licenses:            [11554731, 96023021]
   
   Licenses to be added:   96023021
   
   ? Are you sure you want to proceed with these changes?

   User 2 confirms by answering Yes, and the output shows:

   Licenses registered successfully.
   License: 11554731 | Owner: Example User 1 | Seat amount: 20
   License: 96023021 | Owner: Example User 1 | Seat amount: 3

4. User 3, another deputy license manager, takes over the On-Prem Qt License Server instance and wants to remove an existing registration and to add another license. User 3 runs the command:

   ./qt-license-server register -e example.user3@company.com -p 3333333333 --url https://my.onprem.instance.addr:8080 -l 96023021 96023022

   The output shows a summary of the changes and requests confirmation before proceeding:

   Registration Change Summary:
   Currently registered licenses: [11554731, 96023021]
   Requested licenses:            [96023021, 96023022]
   
   Licenses to be removed: 11554731
   *** Note: You might be removing licenses, which this account, example.user3@company.com, does not have rights to! ***
   If so, those licenses can't be re-registered back anymore using this account.
   
   ? Are you sure you want to proceed with these changes?
   

   User 3 confirms by answering Yes, and the output shows:

   Licenses registered successfully.
   License: 96023021 | Owner: Example User 1 | Seat amount: 3
   License: 96023022 | Owner: Example User 1 | Seat amount: 20

5. User 1, the license manager, wants to deregister all licenses on the On-Prem Qt License Server instance. User 1 runs the command:

   ./qt-license-server deregister -e example.user1@company.com -p 1111111111 --url https://my.onprem.instance.addr:8080

   The output shows a summary of the changes and requests confirmation before proceeding:

   Warning: You are about to deregister all licenses:
   Currently registered licenses: [96023021, 96023022]
   All licenses will be removed from this on-premises instance.
   
   *** Note: You might be removing licenses, which this account, example.user1@company.com, does not have rights to! ***
   If so, those licenses can't be re-registered back anymore using this account.
   
   ? Are you sure you want to deregister all licenses?
   

   User 1 confirms by answering Yes, and the output shows:

   Licenses deregistered successfully.
   Logout for user example.user1@company.com
   All licenses deregistered. This instance does not host any licenses.