Licensing QHB Version 1.5.3

IMPORTANT!
Without a license, the performance of the DBMS is limited.

Binary Utilities

qhb-serial Utility

The host hardware identification utility qhb-serial is supplied as part of the eponymous package qhb-serial.

When installed, it is placed in a public directory, usually /usr/bin/.

The utility is used to request hardware IDs of the host or virtual machine where QHB is installed, to send them to the vendor or dealer of QHB. Based on this information, a license file is generated, linked specifically to this host or virtual machine.

To run the utility:

Note
On some distributions, the qhb-serial command must be executed from a user with superuser rights in case of an access error.

qhb-serial

Parameters:

running without parameters
Display the serial number of the current host if it is not a virtual machine.

-u
--uuid
Display system-uuid of the virtual machine instead of serial number of the current host.

-s
--cpus
Display the number of host or virtual machine cores that will be taken into account when checking the license.

-r
--report
Generate a complete output of host or virtual machine parameters for sending to the vendor and generating a license file.

--help
Show help about qhb-serial command line arguments, and exit.

Running the utility to request information when activating the license

qhb-serial --report

qhb-license Utility

The license file viewing utility qhb-license is supplied as part of the qhb-license-bin package.

When installed, it is placed in a public directory, usually /usr/bin/.

The utility is used to view the parameters of the license file received from the vendor or dealer QHB.

Example of running the utility:

qhb-license --license-path /var/lib/qhb/data/license

Example of utility output:

Идентификатор лицензии: fa4764bf-5fd8-4579-b8cb-d90b7259f62d
Идентификатор аппаратного обеспечения (HID): 37245DA9E484489EDD71F263E0CDF9F8
Идентификатор системы (UUID): B5AD08BC368E984DA7AD7A407D7F705D
Дата начала действия лицензии: 2023-03-15
Дата начала срока тех. поддержки: 2023-01-10
Дата окончания срока тех. поддержки: 2023-11-11
Имя пользователя: USERNAME
Код пользователя: USERCODE
Имя продукта: СУБД Квант-Гибрид
Код продукта: QHB-std1
Код сделки: BARGAINCODE
Номер релиза: 1.5
Редакция: FULL
Тип лицензии: TEST
Список лицензионных метрик
        CONNECTIONS: 2
        PROC: 8
Тип продукта: DBMS
Дата окончания действия лицензии: 2023-11-11

To get brief help, run the utility with the --help flag.

qhb-license --help

Obtaining a License File

The client receives a license file, which is necessary for using QHB. Along with the license file, the client receives a license number, by which it can be identified. This number is also necessary for contacting technical support.

Applying License Parameters

When launched, QHB expects the presence of a license file license in the directory where it is installed, for example /usr/local/qhb/license.

To check the license, it is necessary to identify the user's host hardware, which is performed by the qhb-serial package. This utility is also required to start QHB and utilities that require the presence of a license file.

Note
The qhb-serial utility may not be required to run utilities such as qcp and qdl if the host hardware identification is not written in the license file.

When checking the compliance of the licensing parameters specified in the license file of the current distribution QHB, the following messages are displayed:

initially, when the version is displayed, brief information about the validity period of the license is printed;
then, any errors found in loading and validating the license are displayed in the regular message log.

Requesting License Parameters During Operation

For the convenience of the QHB administrator, a SQL function is provided that allows you to retrieve the details of the currently used license.

Valid values	Description
lid	License ID
hid	Hardware ID
system_uuid	System UUID
license_start	License start date
support_start	Technical support start date
support_stop	Technical support end date
valid_thru	License expiration date
user_name	Username
user_code	User code
release	Current release
product_name	Product name
product_code	Product code
bargain_code	Bargain code
license_type	License type
edition	Edition
product_type	Product type

For example:

# select qhb_license_info('product_code');
-- QHB

# select qhb_license_info('release');
-- 1.3

Additionally, a SQL function is provided that allows you to immediately obtain all the details of the currently used license in the form of a table.

# select attname, attvalue from qhb_license();

If the specified parameter cannot be processed, the qhb_license_info function returns an empty string as a value of type text.

The returned data corresponds to the values specified in the license itself (license file), and may differ from the values corresponding to the QHB build.

Client Actions in Case of License Loading Error

During a normal license check (when running QHB), two types of errors may occur:

license loading errors;
license validation errors relative to the current QHB build/release.

In case of a license loading error, make sure that:

the license is located in the path expected by the product: in the installation directory, for example /usr/local/qhb/license;
the license file has not been modified after receiving it from the commercial department (the file is cryptographically signed, and any edits make it invalid);
the QHB user has permissions to read the license file.

If these conditions are met and the error occurs again, you should contact technical support.

Client Actions in Case of License Validation Error

In case of a license validation error, detailed information about the error is available at the beginning of the QHB log file generated at start.

The message includes the validation result (each invalid parameter is displayed in a new string) and a short instruction for further actions, localized for the current OS settings (LC_ALL=ru/en).

QDL and QCP Licensing

When running, these utilities expect the presence of a license file qdl-license or qcp-license (similar to QHB) in the directory where the executable file is located.

Messages about download and license validation errors are written to the log of the corresponding utilities (depending on the settings, these may be standard I/O streams or a log file).

The ability to request license parameters for utilities while they are running is not provided in this release.

In case of a license validation error, detailed information about the error is available in the form of a validation result (each incorrect parameter is displayed in a new string) and a brief instruction for further actions (the output depends on the current locale settings).