> For the complete documentation index, see [llms.txt](https://help.connected.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.connected.illumina.com/dragen/dragen-v4.6/reference/licensing/onprem_licensing.md).

# DRAGEN Server Licensing

DRAGEN Servers use Legacy Gigabase Pricing: a prepaid quota of gigabases. This quota is separate from BioInsight Credits used in BioInsight Platform Core. Contact [Illumina Sales](https://www.illumina.com/company/contact-us.html#/sales) for pricing.

On-Premises DRAGEN supports both Connected and Dark Site Licensing.

{% hint style="info" %}
A DRAGEN Server can alternatively be used in Software Mode, running DRAGEN on the server's CPUs and authenticating with an Illumina BioInsight Platform API key instead of installed licenses. In that case the licensing on this page does not apply, and DRAGEN 4.6 runs use DRAGEN Pricing. See [BioInsight Platform Licensing](/dragen/dragen-v4.6/reference/licensing/api_key_licensing.md).
{% endhint %}

## Installing Licenses

Connected DRAGEN servers automatically retrieve the latest licenses assigned to it once per day, meaning typically no user action is needed to install licenses.

For those who need to manually install licenses - the dragen\_lic tool which comes packaged with DRAGEN can be utilized. Note, installing licenses with the dragen\_lic tool requires root privilege.

* Manually install license using Illumina License Server --> Using the dragen\_lic tool, you can force DRAGEN to retrieve the latest licenses available to you from Illumina. See the example below.
* Manually install license using a file --> Using the dragen\_lic tool, you can install a license binary file (ending with the .bin extension). Note, there can be upwards of 7+ Licenses assigned to your server, and each individual license file would have to be installed using this command. This is not the preferred method of installing a license and should be reserved for Dark Site systems only. See the example below.

### dragen\_lic tool location

The dragen\_lic tool can be found at /usr/bin/dragen\_lic.

{% hint style="warning" %}
**DRAGEN 4.2 and earlier**: `dragen_lic` is located at `/opt/edico/bin/dragen_lic` instead.
{% endhint %}

### Manually install license using Illumina License Server (Connected);

The following command will automatically attempt to download all available licenses assigned to you via the Illumina License Server.

```
sudo dragen_lic -i auto
```

{% hint style="warning" %}
**DRAGEN 4.4.4 only**: If PipSeq is not already installed, `sudo dragen_lic -i auto` will **not** retrieve it. You must explicitly request it by name using the `-f` option, as shown below.

This limitation is specific to **DRAGEN 4.4.4**. On **DRAGEN v4.4.6 and later**, the standard `sudo dragen_lic -i auto` command is sufficient to install PipSeq.
{% endhint %}

```
sudo dragen_lic -i auto -f PipSeq
```

### Manually install license using a file (Offline)

For each license file you receive and want to manually install, you would need to run the following command;

```
sudo dragen_lic -i <license file received>.bin
```

As an example, let's say you receive a zipfile containing the following license files; Genome, Compression, CNV, Somatic, Transcriptome, and JointGenotype.

```
sudo dragen_lic -i license_genome.bin
sudo dragen_lic -i license_compression.bin
sudo dragen_lic -i license_cnv.bin
sudo dragen_lic -i license_somatic.bin
sudo dragen_lic -i license_transcriptome.bin
sudo dragen_lic -i license_jointgenotype.bin
```

## Retrieving License Information and Usage

There are three options for retrieving information and usage regarding your installed licenses. Examples for each one are below.

{% hint style="warning" %}
**Version requirement**: Basic Output (`-b`) and JSON Output (`-j`) require **DRAGEN 4.3 or higher**. On earlier versions, Detailed Output (no flag) is the only method available.
{% endhint %}

* Basic Output (i.e., using the -b flag). This is the recommended method to view license information by a human user as the output is simplified to be more readable.
* JSON Output (i.e., using the -j flag). This is the recommended method to view license information by a machine user as the output is already in a machine readable format.
  * **DRAGEN 4.3**: a single license object per license type. **DRAGEN 4.4 and higher**: a list of license objects per license type.
* Detailed Output (i.e., no additional arguments). This is the default method for retrieving license information. In general it is recommended to instead use one of the above two options if possible.

{% hint style="info" %}
`dragen_lic` reports installed prepaid licenses and their quota.
{% endhint %}

```
$ dragen_lic -b
SN: <serial number>
DRAGEN Version: <DRAGEN version>
Time: <time>

DRAGEN Core:
    Status: Active
    Used: 68.0 Gbases since 2023-Dec-05
    Quota: 100250 Gbases
    Expiry: 2024-Feb-13
    Includes; Genome, JointGenotype, CNV, Somatic, Transcriptome License(s)

Compression:
    Status: Active - !!! EXPIRING IN LESS THAN 30 DAYS !!!
    Used: 0 Gbases since 2024-Jan-12
    Quota: Unlimited
    Expiry: 2024-Feb-13

TSO500Combined:
    Status: Active
    Used: 23518284 Gbases since around 2022-Jul-15
    Quota: Unlimited
    Expiry: 2050-Jan-01

TSO500_HRD:
    Status: Active - !!! EXPIRING IN LESS THAN 30 DAYS !!!
    Used: 0 Gbases since around 2024-Jan-07
    Quota: Unlimited
    Expiry: 2024-Feb-13
```

```
$ dragen_lic -j
{"dragen_boards":[{"board_sn":"<serial_number>","installed_licenses":{"Compression":[{"expiry":"2025-Mar-19","quota_limit":100250,"start":"2023-Dec-01","status":"Active","units":"Gbases","used":5223}],"TSO500Combined":[{"expiry":"2050-Jan-01","quota_limit":-1,"start":"2022-Jul-13","status":"Active","units":"Gbases","used":23518284}],"TSO500_HRD":[{"expiry":"2024-Feb-13","quota_limit":-1,"start":"2021-Oct-13","status":"Active","units":"Gbases","used":0}],"Dragen_Core":[{"expiry":"2024-Feb-13","includes":{"CNV":{"expiration":"2025-Mar-19","status":"Active"},"Genome":{"expiration":"2024-Feb-13","status":"Active"},"JointGenotype":{"expiration":"2025-Mar-19","status":"Active"},"Somatic":{"expiration":"2025-Mar-19","status":"Active"},"Transcriptome":{"expiration":"2025-Mar-19","status":"Active"}},"quota_limit":-1,"start":"2023-Oct-14","status":"Active","units":"Gbases","used":79708}]}}],"generated":"<ISO time>"}
```

```
$ dragen_lic
LICENSE_MSG| ---- Board (SN: <serial number>) ----
LICENSE_MSG| ---- DRAGEN Version: <DRAGEN version> ----
LICENSE_MSG| ---- Time: <time> ----

LICENSE_MSG| License Genome          : used 68.0/100250 Gbases since 2023-Dec-05 (67961825900 bases, 0.1%)
LICENSE_MSG|   issued=2023-Dec-04, start=2023-Dec-01, expiry=2023-Dec-19, period=15 months
LICENSE_MSG| License JointGenotype   : used 0.0 Grecords since around 2023-Dec-04 (0 records, unlimited)
LICENSE_MSG|   issued=2023-Dec-04, start=2023-Dec-01, expiry=2023-Dec-19, period=15 months
LICENSE_MSG| License Transcriptome   : used 0.0 Gbases since around 2023-Dec-04 (0 bases, unlimited)
LICENSE_MSG|   issued=2023-Dec-04, start=2023-Dec-01, expiry=2023-Dec-19, period=15 months
LICENSE_MSG| License GATK-accelerated: used 0.0 Gbases since around 2023-Nov-06 (0 bases, unlimited)
LICENSE_MSG|   issued=2023-Nov-06, start=2021-Oct-13, expiry=2023-Dec-13, period=1 month
LICENSE_MSG| License Somatic         : used 0.0 Gbases since 2023-Dec-04 (0 bases, unlimited)
LICENSE_MSG|   issued=2023-Dec-04, start=2023-Dec-01, expiry=2023-Dec-19, period=15 months
LICENSE_MSG| License CNV             : used 0.0 Grecords since around 2023-Dec-04 (0 records, unlimited)
LICENSE_MSG|   issued=2023-Dec-04, start=2023-Dec-01, expiry=2023-Dec-19, period=15 months
LICENSE_MSG| License TSO500          : used 0.0 Gbases since around 2023-Nov-06 (0 bases, unlimited)
LICENSE_MSG|   issued=2023-Nov-06, start=2021-Oct-13, expiry=2023-Dec-13, period=1 month
LICENSE_MSG| License TSO500Solid     : used 24.0 Gbases since around 2023-Nov-06 (24000000000 bases, unlimited)
LICENSE_MSG|   issued=2023-Nov-06, start=2021-Oct-13, expiry=2023-Dec-13, period=1 month
LICENSE_MSG| License Compression     : used 0.0/100250 Gbases since 2023-Dec-04 (0 bases, 0.0%)
LICENSE_MSG|   issued=2023-Dec-04, start=2023-Dec-01, expiry=2023-Dec-19, period=15 months
LICENSE_MSG| License TSO500_HRD      : used 0.0 Gbases since around 2023-Nov-06 (0 bases, unlimited)
LICENSE_MSG|   issued=2023-Nov-06, start=2021-Oct-13, expiry=2023-Dec-13, period=1 month
LICENSE_MSG| License TSO500Combined  : used 23518260.0 Gbases since around 2022-Jul-15 (23518260000000000 bases, unlimited)
LICENSE_MSG|   issued=2022-Jul-15, start=2022-Jul-13, expiry=2050-Jan-01, period=12 months

LICENSE_MSG| -- License dongle
LICENSE_MSG|   STATUS   : OK
LICENSE_MSG|   DONGLE SN: <serial number>
LICENSE_MSG|   RELEASE  : <dongle release number>
LICENSE_MSG|   CHIPID   : *<chip ID>
LICENSE_MSG| DNA: active, accelerators=DNA
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| RNA: active, accelerators=RNA
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| GZIP: active, accelerators=GZIP
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| GUNZ: active, accelerators=GUNZ
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| HMM: active, accelerators=HMM
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| SMW: active, accelerators=SMW
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| RANS: active, accelerators=RANS
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| GRAPH: active, accelerators=GRAPH
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
LICENSE_MSG| DeepRTA: active, accelerators=DeepRTA
LICENSE_MSG|   issue=2023-Dec-04, start=2021-Oct-13, expiry=2050-Jan-01
```

* Basic mode (-b) will not show a license if it has been expired by more then 90 days.
* Basic mode (-b) and JSON mode (-j) collapse the "DRAGEN Core" licenses (Genome, Somatic, CNV, JointGenotype, and Transcriptome) into a single entry, as this is effectively how these licenses are bundled and sold.

### Connected DRAGEN - License Server Domain

A connected server should be capable of reaching the Illumina DRAGEN License server via HTTPS, license.dragen.illumina.com.

{% hint style="warning" %}
**DRAGEN 4.3 and earlier**: Use a different domain, `lus.edicogenome.com`, reached over HTTP (with an encrypted payload) instead of HTTPS.
{% endhint %}

To verify connectivity to the license server, you can query the healthcheck endpoint which will return a 200 status code and a small JSON body if successful.

```
curl https://license.dragen.illumina.com/healthcheck/version --header 'Content-Type: application/json'
{"version":"<server version>"}
```

**Notes**:

* If you are using DRAGEN with a proxy, please make sure the following entities are using the proxy.
  * Root User who will be installing DRAGEN licenses.
  * dragen\_licd systemd service for maintaining licenses.

## Run information collected

For the run information Illumina collects for each run, see [Run information collected](/dragen/dragen-v4.6/reference/licensing.md#run-information-collected).

## Notes

* If performing a destructive system operation like an OS upgrade, please be sure to follow the OS Upgrade instructions [DRAGEN Platform upgrade instructions](https://knowledge.illumina.com/software/on-premises-software/software-on-premises-software-reference_material-list/000007439).
* More information on Iterative gVCF Genotyper Licensing can be found in the [iGG user guide.](/dragen/dragen-v4.6/product-guides/dragen-v4.6/dragen-dna-pipeline/iterative-gvcf-genotyper.md#iterative-gvcf-genotyper-licensing)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.connected.illumina.com/dragen/dragen-v4.6/reference/licensing/onprem_licensing.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
