Documentation

Documentation

mc license register

Table of Contents

Description

The mc license register command connects your deployment with your MinIO SUBNET account.

After registration, you can upload deployment health reports directly to SUBNET using the mc support diag command.

Examples

Register a Deployment Using the Deployment’s Name

Register the MinIO deployment at alias minio1 on SUBNET, using minio1 as the deployment name:

mc license register minio1

If not already registered, a prompt asks for SUBNET credentials for the deployment.

Register a Deployment with a Different Deployment Name

Register a MinIO deployment at alias minio2 on SUBNET, using second-deployment as the name:

mc license register minio2 --name second-deployment

Register a Deployment Without Direct Internet Access

Register a MinIO deployment at alias minio3 on SUBNET that does not have direct Internet access due to a firewall, airgap, or the like.

mc license register minio3 --airgap
  1. Run the command to return a registration token

  2. Copy the registration token

  3. In a web browser, go to https://subnet.min.io and log in with your MinIO SUBNET credentials

  4. Select the Register button

  5. Select No for the question “Is the cluster connected to the internet?”

  6. Paste the copied token into the box for Register using MinIO Client Utility

  7. Select Register

  8. Copy the API token that displays

  9. Back in the terminal, paste or enter the API token to complete the registration process

Syntax

The command has the following syntax:

mc [GLOBALFLAGS] license register       \
                         ALIAS          \
                         [--name value] \
                         [--airgap]

Parameters

ALIAS
Required

The alias of the MinIO deployment.

--name
Optional

Specify a name other than the alias to associate to the MinIO deployment in SUBNET.

Use --name <value> replacing <value> with the name you want to use for the deployment on SUBNET.

--airgap
Optional

Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration).

For instructions, see the airgap example.

If the deployment is airgapped, but the local device where you are using the minio client has network access, you do not need to use the --airgap flag.

Global Flags

This command supports any of the global flags.

Behavior

Automatic License Updates

New in version RELEASE.2023-01-18T04-36-38Z.

Once registered for MinIO SUBNET, MinIO automatically checks for and updates the license every month.

In airgapped or other environments where the server does not have direct access to the internet, use mc license update with the path to the file to update the registration.