Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The information on this page refers to License Statistics v6.14 21 and newer, which introduced stable API v3the ability to use DNS and rDNS lookup to find missing host details during import. If you are using a version previous to v6.21, see documentation for previous versions

You can import license server data to an existing license server. License server data importation is available only when:

...

Code Block
languagebash
#!/bin/sh 
curl -X POST "{HOSTNAME}/api/v3/admin/license-server/{LICENSE_SERVER_ID}/import?gather={GATHERING}&mergePolicy={MERGE_POLICY}&from={FROM}&to={TO}&resolveDomainNamesToIP={DNS}&findDomainNamesByIP={RDNS}" \ 
  -H "accept: application/json" \ 
  -H "X-Auth-token: {API_TOKEN}" \ 
  -H "Content-Type: multipart/form-data" \ 
  -F "file=@{FILE}"

where:

Query ParameterExample VariableTypeDescriptionDefault

HOSTNAME
stringLicense Statistics instance

LICENSE_SERVER_ID
integerLicense Server ID
gather
GATHERING
string

Denials and/or Usage

"Denials,Usage"
mergePolicy
MERGE_POLICY
stringReject/Replace/Merge/Leave Tail "Reject"
from
FROM
stringStart of time range import; format: yyyy-MM-dd HH:mm[:ss]Beginning of the log file
to
TO
stringEnd of time range import; format: yyyy-MM-dd HH:mm[:ss] End of the log file
resolveDomainNamesToIP
DNS
booleanFind unknown host IP address using DNS lookupfalse
findDomainNamesByIP
RDNS
booleanFind unknown hostname using Reverse DNS lookupfalse

API_TOKEN
stringAPI token

FILE
stringName of the file to import

...

Code Block
languagebash
#!/bin/sh

curl -X POST "https://licstat-demo.x-formation.com/api/v3/admin/license-server/40/import?gather=Denials&from=2021-01-10%2015%3A10%3A00&to=2021-02-10%2019%3A13%3A23" \
-H "accept: application/json" \
-H "X-Auth-token: e765ee9c3ded6ca6e5e7f4d0d01189d0" \
-H "Content-Type: multipart/form-data" \
-F "file=@license-server.log"

Example 6

Response

The following example shows using the import API command for importing data using DNS and rDNS lookup for missing IP addresses and hostnames, respectively.

Code Block
languagebash
#!/bin/sh

curl -X POST "https://licstat-demo.x-formation.com/api/v3/admin/license-server/40/import?resolveDomainNamesToIP=true&findDomainNamesByIP=true" \
-H "accept: application/json" \
-H "X-Auth-token: e765ee9c3ded6ca6e5e7f4d0d01189d0" \
-H "Content-Type: multipart/form-data" \
-F "file=@license-server.log"

Response

The import operation is asynchronous, and all the examples given above add a Import operation is asynchronous and all above examples are adding new task to the queue. In The "tid" key in the success response you can find unique identified contains the unique identifier of the task available under "tid" key

Code Block
{
    "success": true,
    "msg": null,
    "data": {
        "sst": "SCHEDULED",
        "ti": {
            "data": null,
            "sbtr": "Administrator",
            "sbtd": "2021-12-20 11:47:35",
            "tid": "import_527ddd6f-d7de-4854-bc99-839b5afd458e",
            "sts": "PENDING",
            "err": null
        }
    }
}

...

You can either check the status of the task periodically in the script periodically until it 's processed successfully has completed processing successfully, or simply close the script execution and wait for some time for the import allow the task to be processed completed in the background.

Task status request

...