Manage License Buckets with JFrog CLI

Use the JFrog CLI Mission Control (mc) commands to acquire a license key, deploy licenses directly to a registered JFrog Platform Deployment (JPD), or return licenses to a license bucket.

Prerequisites

Before you use the license bucket commands, verify that you have:

• The Mission Control microservice enabled on your JFrog Platform. For instructions, see Mission Control Installation.
• A license bucket loaded into Mission Control. For instructions, see Manage License Buckets.
• A Mission Control admin access token.
• A registered JPD if you plan to deploy licenses directly to it.
• JFrog CLI installed. For instructions, see Install JFrog CLI.

Configure the Connection

Configure a JFrog Platform connection before you run the license bucket commands. The CLI derives the Mission Control URL from the platform URL:

jf config add my-platform \
  --url=https://jfrog.example.com \
  --access-token=<access-token> \
  --interactive=false

For more configuration options, see Configure the JFrog CLI.

You can also provide connection details with each command. When you use command options, set --url to the Mission Control URL:

jf mc <command> \
  --url=https://jfrog.example.com/mc \
  --access-token=<access-token>

Choose a License Command

The following table explains when to use each license bucket command.

Acquiring and deploying are separate operations. You don't need to acquire a license before you deploy one to a JPD.

Acquire a License

Use license-acquire to reserve a license from a bucket and mark it with a custom name. The command returns the license key but doesn't deploy it to a JPD.

jf mc license-acquire [command options] <bucket-id> <name>

For example, acquire a license and return JSON output:

jf mc license-acquire my-bucket temporary-holder --format=json

The following table describes the arguments.

The following table describes the options.

If you don't use the acquired license, return it to the bucket by passing its custom name to license-release:

jf mc license-release my-bucket temporary-holder

Deploy a License

Use license-deploy to deploy a license from a bucket directly to an existing JPD. For an Artifactory high availability (HA) deployment, use --license-count to deploy multiple licenses.

jf mc license-deploy [command options] <bucket-id> <jpd-id>

For example, deploy one license:

jf mc license-deploy my-bucket my-jpd

To deploy three licenses to an Artifactory HA JPD:

jf mc license-deploy my-bucket my-ha-jpd --license-count=3

The following table describes the arguments.

The following table describes the options.

Release a License

Use license-release to return a license to the bucket from which it was allocated.

• For a license deployed to a JPD, pass the JPD ID.
• For an acquired license that wasn't deployed, pass the custom name used with license-acquire.

jf mc license-release [command options] <bucket-id> <jpd-id>

For example, release a license deployed to a JPD:

jf mc license-release my-bucket my-jpd

To release an unused acquired license:

jf mc license-release my-bucket temporary-holder

The following table describes the arguments.

The following table describes the options.

Related Topics

• Manage Licenses and License Buckets
• Configure the JFrog CLI
• Mission Control Installation
• Get License Buckets REST API