licenseFile

licenseFile — enables the driver license, using a license file.

Synopsis

       
(license license_filename)
	

Parameters

license_filename

The filename (including filepath if needed) of a file containing one or more licenses.

Returns

OK, if the file is found. If a valid board and license combination is found, the following message will be printed to the standard output stream:

License for board board Accepted.

If the command failed (license file not found), then the following error message is returned:

(error "license -1 (time) License file license_filename not found.")

Description

This command enables the driver license based on a file of licenses. In order to start, most drivers will require a license, which is often unique to the particular hardware and software installed.

This command is normally executed from the configuration file. It is intended to help manage licensing for installations with multiple cards. A file can be created with all the purchased licenses that pertain to an installation, and then referenced from each unique configuration file. This avoids the need to create different configuration files just for the purpose of supplying different licenses.

Use of a single multi-license file also simplifies addition of new licenses (at a single point) as well as swapping card hardware between machines. The license file contains a list of licenses, each as required by the specific type of hardware/software, one per line. All licenses are tested against all initialized cards (cards), until at least one valid license is found.

Example

(licenseFile /usr/cogent/driver/licenses/cogent_licenses)