| DISCLAIMER |
|---|
| This script is provided as-is and is not supported by HP Teradici. It is intended to provide a reference for accessing the License Server (LS) or Cloud License Service (CLS) APIs. Please report any issues via github. |
Tool that displays the maximum HP Anyware license concurrent usage over time. Once the tool is started, it will continue to run and output results until terminated.
To install the dependency packages, run:
python3 -m pip install -r requirements.txt
Create a filename named: .env in the checkout directory that contains the following:
LS_URI=https://<address-of-license-server>:<port> OR <your-cloud-license-service-id>
LS_USERNAME=<username>
LS_PASSWORD=<password>
This information will be automatically used at startup. Alternatively, this information can be provided as command line parameters --ls-uri, --ls-username, and --ls-password
usage: pcoip-agent-ls.py [-h] --ls-uri LS_URI [--ls-username LS_USERNAME]
[--ls-password LS_PASSWORD] [--duration DURATION]
[--alert-threshold ALERT_THRESHOLD] [-o OUTPUT_FILE]
This script displays the maximum HP Anyware license concurrent
usage over the Duration period
optional arguments:
-h, --help show this help message and exit
--show-license-usage Outputs individual license usage and exits. Outputs the results in a tablet or as json if the
--json command line option is provided.
--json Outputs results in json instead of a table
--duration DURATION Periodically query license usage over the defined duration (in minutes) and output the
results. Defaults to 4 hours. (min 120 seconds).
--alert-threshold ALERT_THRESHOLD
Percentage from 0-100 of used licenses available that will trigger an alert.
-o OUTPUT_FILE, --output-file OUTPUT_FILE
Saves the results to a file. Currently the only supported format is json
Required arguments:
--ls-uri LS_URI Local License Server URL (Example: https://10.0.1.1:7071) or Cloud License Service ID
(Example: 1EJD8DXUKQWQ). The value can be set from the environment variable: LS_URI
--ls-username LS_USERNAME
License Server Username. This is likely 'admin'. The value for this can be set from the
environment variable: LS_USERNAME
--ls-password LS_PASSWORD
License Server Password. The value for this can be set from the environment variable:
LS_PASSWORD
(1) A warning will be printed if using http:// to communicate with Local License Server. HP Teradici highly recommends communicating over secure connections (https://). See License Server Administration Guide "How to enable HTTPS/TLS for PCoIP License Server" at https://help.teradici.com.
(2) To get your Cloud License Service ID, this is the first part (left of the @) in the Registration Code you received from HP Teradici. For example, if the Registration Code is XXXXXXX@YYYY-YYYY-YYYY-YYYY, the Cloud License Service ID will be XXXXXXX.
(3) To set the Cloud License Service password, do the following:
- Log into https://teradici.flexnetoperations.com. To request access, create a case with HP Teradici support. Be prepared to provide a valid Registration Code, and the name and email address of a contact person who should have access.
- Go to "Served Licenses" -> "License Server" -> <your CLS ID> -> "Set Password".
(4) The Local License Server password is the same password used when the Local License Server was initially setup.
This script takes advantage of the REST APIs documented at
- for LS,
https://<address-of-ls>:<port>/documentation - for CLS, https://teradici.compliance.flexnetoperations.com/GlobalLicensingService/swagger-ui/index.html