CLI: Licensing

Learn how to use the CLI to manage your DryvIQ Platform license.


Overview

The DryvIQ Command-line Interface (CLI) enables you to manage and validate DryvIQ licenses directly from the command line. You can view license details, apply new licenses, and verify compliance without using the UI. This page explains the available commands and provides guidance for managing licensing via the CLI. Note that the authentication parameters are provided within the configuration file. Refer to “CLI: Authentication” for more information.

SkySync References

The CLI references SkySync. This is expected. 

 

Show an Active License

This command shows the details of the active license.

Command With Example Values

skysync-cli license show

Example Results

License  123
Customer Acme Co (john@acme.com)
Expired

Example JSON Results

[
  {
    "key": "123",
    "customer": {
      "name": "Acme Co",
      "email": "john@acme.com"
    },
    "product": {
      "name": "SkySync v4"
    },
    "edition": {
      "name": "Enterprise"
    },
    "features": [
      "connection_a",
      "connection_b"
    ]
]

Activate a New License Key

This command allows you to activate one or more nodes using a license key. The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command With Variables

skysync-cli license activate {{key}}

Command With Sample Values

skysync-cli license activate 123

Example Results

License  123
Customer Acme Co (john@acme.com)
Expired

Refresh Current License

This command allows you to refresh a license with the latest details from our licensing server. It can be useful if you recently changed your license, such as adding additional supported connectors.  

Command

skysync-cli license refresh

Example Results

License  123
Customer Acme Co (john@acme.com)
Expired

Example JSON Results

[
  {
    "key": "123",
    "customer": {
      "name": "Acme Co",
      "email": "john@acme.com"
    },
    "product": {
      "name": "SkySync v4"
    },
    "edition": {
      "name": "Enterprise"
    },
    "features": [
      "connection_a",
      "connection_b"
    ]
]