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
You can easily list license servers registered in License Statistics by sending the following HTTP request.
Obtaining feature list
To list features recognizable by License Statistics, use the following request:
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/featurelicense-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 |
Code Block | ||
---|---|---|
| ||
{ "lsid": "1", "lsn": "1", "fid": "1", "fns": "1", "fv": "1", "ftype": "1", "lus": "1", "lco": "1", "lbe": "1", "uid": "1", "un": "1", "hn": "1"} |
where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.
If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty.
Applies filtering to narrow down the results.
To filter by a string column, use the following format:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "${fns | fv | ftype | lsn | vn | gtn}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | lsid}",
"value": "${value}"
}
] |
Response
The response you get may be similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"success": ${success},
"msg": ${message},
"data": [{
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"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. - To get the list of all License Statistics features, type the following from a command line:
Example 1
Say you want to obtain a list of all license servers. To generate this data set, enter a command similar to the following.
Code Block | ||||
---|---|---|---|---|
| ||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/featurelicense-server/json" |
Example 2
If you want to generate license server information filtered by hostname in CSV format - To obtain feature information filtered by name and version, enter the following command:.
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"fnlsh\", \"value\"=\"abc\"}, {\"type\"=\"string\", \"field\"=\"fv\", \"value\"=\"2.1\"some hostname\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/featurelicense-server/jsoncsv" |
Example 3
In order to get information about a license server with an ID of 1- To get feature information filtered by Id, enter the following command: .
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"fidlsid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/featurelicense-server/json" |