License Monitor
- Asif Habibullah
- Amna
Overview
The License Monitor is a tool in the CSI Customer Center, providing a live snapshot of your account's CSI License Usage. The gauges at the top of the page show a summary of the licenses in use versus the total number of licenses. The tables below provide details for which licenses are in use and by which user. The License Monitor can be found in the CSI Customer Center under Cloud Licensing Tools > License Monitor.
Required Permissions
To view the License Monitor in the CSI Customer Center, a user must be assigned a role with the “Cloud License Monitor” permission selected. This permission is enabled by default on all template roles.
Terminating User Sessions
Remote termination of a Cloud Sign-in license on a user’s machine is available in the License Monitor. Once terminated, the software will close on the user’s machine. Checked-out licenses and non-Cloud Sign-in licenses cannot be remotely terminated.
The option to terminate a session is available as follows:
Any Cloud Sign-in license user can terminate their own session (with “Cloud License Monitor” permission to view the License Monitor).
A Customer Account Administrator can terminate any session in their customer account.
A user with the User Role permission of “Terminate Sessions” can terminate any session in their customer account. A user can be assigned this role by their Customer Account Administrator in the CSI Customer Center in the User Management Dashboard.
External / API Access
Users can access/view the Cloud License Monitor without having to sign into the CSI Customer Center using an External / API Access link.
Generating this link can be done by the Customer Account Administrator(s) under the Cloud Licensing Tools > Licensing Monitor menu, on the External / API Access tab on the far right, using the “Generate New External / API Access” Link button.
Once created, two links will be generated. The HTML link can be used to embed the License Monitor within your company internets. The JSON link can be used to programmatically access the data from the License Monitor for Cloud Sign-in Licenses.. If the External / API Access Link is deleted, both of these URL links will no longer work.
Application Programming Interface (API)
The data shown in the Cloud License Monitor for Cloud Sign-in licenses can be accessed via API, using the JSON link generated above, allowing you to programmatically query the license server from a third-party application. The data will be returned in JSON format.
Documentation
Definition and explanations of the parameters above are given below.
CUSTOMER INFORMATION BLOCK
Parameter | Description |
|---|---|
EntityId | Customer Account Number |
CompanyName | Customer Account Name |
ProductLicenseActivities | Information for the product gauges at the top of the page |
Product | Name of CSI Product |
NumberLicensesInUse | Number of licenses for that product in use |
NumberLicensesTotal | Number of total licenses available for that product |
PRODUCT LICENSE USAGE TABLE
Parameter | Description |
|---|---|
AssetId | Asset number |
ItemClass | CSI product name |
ItemLevel | Product level |
InUse | true = license is currently in use |
ComputerName | Computer name |
UserName | Name of user signed in |
UserEmail | Email address used to sign in |
CheckedOut | true = license is checked out |
CheckoutEndDateTime | Date and time license is checked out until |
UserStartDateTime | Date and time when the current session was started on this computer with this user |
instances | Number of instances of this product running on this machine |
version | Product version |
edition | Product edition |
licenseGroup | Id number of the license group this license is getting pulled from |
licenseGroupName | License group name this license is getting pulled from |