License Administrator Command Line Interface
The command line interface (CLI) runs on all platforms supported by PSQL. The CLI is functionally equivalent to the GUI. You can administer licenses for local or remote database engines with the CLI.
The GUI and the CLI list information about the authorized licenses, such as the type of license, user count, session count, data in use limit, platform, expiration date, and so forth. License key information is also available from the installation media.
CLI Syntax
The CLI uses the same syntax on all platforms:
utility_name -option parameters
The utility name is one of the following:
•
clilcadm.exe (Windows 32-bit)
•
w64clilcadm.exe (Windows 64-bit)
•
clilcadm or clilcadm64 (Linux or OS X)
The following table describes the options and parameters.
Table 13
License Administrator Command Line Options and Parameters  
Options and Parameters
Function
-<interpret | i> key
Lists license information for all keys or for the specified key:
•
Product – The name of the PSQL product, such as Server, Vx Server, or Workgroup.
•
Product Key – The Product Key associated with the corresponding product license.
•
State – The status of the Product Key. Values are Active, Inactive, Expired, Disabled and Failed Validation. (A license may be disabled if certain hardware configuration items have changed since the key was applied.)
•
Platform – The combination of PSQL product, operating system, and bit architecture to which the license applies.
•
License Type – The type of license, such as permanent, temporary or an increase license for user count, session count, or data in use.
•
User Count – The user count for the specific license. See also Concurrent User License Model.
•
Session Count – The session count limit for the specific license.
•
Data In Use GB – The data in use limit in gigabytes for the specific license. See also Capacity-based License Model.
•
Expiration Date – The date on which a license expires, if applicable, or "n/a" if not applicable.
•
Vendor – A unique number identifying the vendor software that installed the license.
•
Application – A unique number identifying the application to which the license applies.
-<authorize | a> <key | authorization_filename.pky>
Authorizes the specified key or authorization key data file (offline authorization).
-<deauthorize | d> key
Deauthorizes the specified key from the computer where the CLI utility is running. If the key is a permanent key, also deauthorizes all increase keys (user count, session count, data in use) associated with the key.
-<clear | c> [key] [force]
Clears from the machine all permanent keys and their associated increase keys for user count, session count, or data in use.
If a key is specified, only the specific key and its associated increases for user count, session count, or data in use are cleared. If no key is specified, all keys and associated increases are cleared.
Note: This command is useful if you are unable to deauthorize a key because of changes in the hardware configuration and you need to authorize another set of keys. You could clear the key(s) and authorize the product with a different key than the one(s) you cleared.
If the force option is included, a confirmation message is not displayed.
Note: This option only removes a key from the local PSQL server. It does not deauthorize the key from the unique machine signature maintained by Actian Corporation. That is, it does not remove the record of the link between the machine signature and the key.
-<generate | g> key output_filename
Generates authorization request data file for offline authorization. The product key and output filename are both required.
-<number | n> [key]
Displays the number of remaining authorizations for the specified key.
Note: If no key is specified, remaining authorization information for all product keys is displayed.
-<servername | s> servername
Allows connection to a specified server, if specified. If not specified, the servername is assumed to be blank. This parameter is optional.
-<validate | t>
Performs a license validation on the connected server name and selected key.
-<username | u>
The user name for the server to which you are connecting. If not specified, the username is assumed to be blank. This parameter is optional and not required if a servername is not specified.
-<password | p> password
The password associated with the user name for the server to which you are connecting. If not specified, the password is assumed to be blank. This parameter is optional and not required if a servername is not specified.
-<help | h>
Displays information about the options and parameters.
-<repair | e> key
Repairs and authorizes a key (if repair is possible). The Repair action requires the following conditions to be met:
•
The key to be repaired must be compatible with the version of the database engine currently installed.
•
The key to be repaired must be in a “disabled” or a “failed validation” state.
•
A permanent key cannot be in the “active” state.
•
There must be Internet access to communicate with the PSQL license service.
•
The allowable number of repairs must not have been exceeded.
For a successful repair, the message “key has been repaired” is returned.
No option or wrong option
Displays information about the options and parameters.
See CLI Tasks for the tasks pertaining to the CLI.