Qt License Server command-line interface
On-premises Qt License Server provides a command-line interface for various operations. For example, export usage logs, manage access control lists, and manually release active reservations.
Usage
To use qt-license-server, enter the following command:
./qt-license-server <command> [options]
.\qt-license-server.exe <command> [options]
Help
To view an up-to-date list of commands, enter:
./qt-license-server --help
.\qt-license-server.exe --help
To view the options of a command, enter:
./qt-license-server help <command>
.\qt-license-server.exe help <command>
For example, to see the options you have for exporting reports, enter:
./qt-license-server help export
.\qt-license-server.exe help export
Version
To view the version number of the Qt License Server running at the specified URL, enter:
./qt-license-server version --url <URL>
.\qt-license-server.exe version --url <URL>
Status
To check the status of the Qt License Server running at the specified URL, enter:
./qt-license-server status --url <URL>
.\qt-license-server.exe status --url <URL>
Commands
The following table summarizes the available commands and their options.
| Command | Options | Description |
|---|---|---|
help | <command> | View the options of a command |
generate-server-fingerprint | None | Generate unique hardware fingerprints for licenses to validate the authenticity of the user hardware. |
purge-unreleased-reservations | --url <URL> | Release expired reservations of a license. |
set-acl | --from-json <filePath> --url <URL> | Set the ACL file to use. |
list-acl | --url <URL> --license <number> | List records for a license number. Omit |
add-acl | --url <URL> --license <number> --userId <ID> | Add a user record to the ACL. |
remove-acl | --url <URL> --license <number> --userId <ID> | Remove a user record from the ACL. |
check-acl-type | --url <URL> --license <number> | Check the ACL type. |
list-long-term-users | --url <URL> --license <number> | List long-term reservations of a license. Omit |
add-long-term-user | --url <URL> --license <number> --userId <ID> | Add a long-term user record to the ACL. |
remove-long-term-user | --url <URL> --license <number> --userId <ID> | Revoke a user's long-term license and shorten their reservation to the usual length. |
release-long-term-reservation | --url <URL> -reservationId <ID> --userId <ID> | Release long-term reservations. |
export | --url <URL> --fileName <fileName> --filePath <filePath> --licenseNumber <number> --startDate <'YYYY-MM-DD'> --endDate <'YYYY-MM-DD'> --extension <extension> --recordType <recordType> | Manage reports on license usage in comma-separated values (CSV) (.csv) or spreadsheet (.xslx) format to view how users are using licenses during the time you specify. |
data-offload | --url <URL> | Offload logs, usage data, and statistics. |
Options
The following table describes the values of the options in more detail. Whether an option is mandatory or optional for a particular command depends on the command. However, always specify the URL where Qt License Server is running.
| Option | Possible values | Description |
|---|---|---|
--action |
| Default action for the specified --license |
--endDate, -ed | YYYY-MM-DD | End date for a report; default: current date |
--extension, -e |
| File format to export reports as; default: xlsx |
--fileName, -f | File name | File name of the report |
--filePath, -p | File path. | Path to the directory where the reports are; default: current directory |
--from-json, -f | File path | Path to the directory that contains acl.json |
--license/--licenseNumber, -l | License number from Qt | The entitlement.json file lists license numbers |
--recordType, -r |
| Type of the report to export |
-reservationId, -ri | Reservation ID | Active reservations reports contain reservation IDs |
--startDate, -sd | YYYY-MM-DD | Start date for a report |
--url, -u | URL | URL of the running license server, required |
--userId, -uid/-ui | username or email address, depending on Qt License Server configuration | User ID |
See also Manage reports, Manage licenses, and Qt License Server configuration.
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
