| Warning |
|---|
| This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
Obtaining a license server list
To You can easily list license servers recognizable by registered in License Statistics , use by sending the following HTTP request:.
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/license-server/${returnType} |
where the $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are as follows: described below.
| Parameter | Required | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which data should be returned. The format can be one of the following: json, csv, xls or pdf. | ||||||||||||||
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. | ||||||||||||||
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored. If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty. | ||||||||||||||
| filter | No | json/string | Applies filtering to narrow down the results. To filter by a string column, use the following format:
To filter by a numeric column, use the following format:
| ||||||||||||||
| limit | No | integer | Specifies the number of records that must be returned. The value must be greater than zero. | ||||||||||||||
| offset | No | integer | Specifies the offset of the first row to return. | ||||||||||||||
| orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: lsid, lsn, lsh, lsp, lsd, vn, gtn | ||||||||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
Response
The response you get may be similar to the following:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"success": ${success},
"msg": ${message},
"data": [{
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"lsh": ${licenseServerHostname},
"lsp": ${licenseServerPort},
"lsd": ${licenseServerDescription},
"vn": ${licenseServerVendorName},
"gtn": ${licenseServerGatheringType}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
...
Error message returned on failure.
...
Error code for unsuccessful request.
| Standard format option. See Making an API request for details. | |||
| standard report options | No | various | See Making an API request for details. |
Response
On success, this report will contain one row for each license server that was queried and is visible for the request. Each row consists of columns:
| Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| lsid | License Server ID | integer | Internal License Statistics identification of the license server |  No |
| lsn | License Server | string | License server name. |  Yes |
| lsh | Hostname | string | Hostname. | Yes |
| lsp | Port | integer | Port number. | Yes |
| lsd | Description | string | Description of the license server. | Yes |
| lsmn | Lic Manager | string | Manager type of the license server; e.g., LM-X, FlexNet, etc. | Yes |
| vn | Vendor | string | Name of the license server vendor. | Yes |
| lss | Status | enumeration | Current status of the license server. | Yes |
| gtn | Gathering | enumeration | See gathering type descriptions for details. | Yes |
| lshal | Redundant | boolean | True if server was configured with redundancy (HAL). |  Unavailable |
| lshf | Has Features | boolean | Indicates whether License Statistics detected any features hosted on the server. True for servers that were successfully queried or imported. | Unavailable |
Note that the order in the table is the default order of the columns in the exported file
...
.
Examples
The following examples make use of the GET method.
Example 1
Say you want to obtain a - To get the list of all license servers, type the following from a command line: . To generate this data set, enter a command similar to the following.
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/json" |
Example 2
- To obtainIf you want to generate license server information filtered by hostname in CSV format, enter the following command:.
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"lsh\", \"value\"=\"some hostname\"}]"
-H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/csv" |
Example 3
In order to get information about a - To get license server information for license server with id an ID of 1, enter the following command: .
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"lsid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/json" |
...