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
...
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, XLSX, 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 XLSX. 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 XLSX types. If provided, it cannot be left empty. | filter | No | json/string |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "${lsn | lsh | lsd | vn | gtn}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${lsid | lsp}",
"value": "${value}"
}
] |
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
Response
The following code block shows an example result of a successful request.
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.
...
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"lsh\", \"value\"=\"some hostname\"}]"
-H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/csv" |
...