mc license register

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

The registration process collects the following information about the cluster for upload to SUBNET:

  • Deployment ID
  • Cluster Name
  • Used capacity
  • AIStor Object Store version
  • Number of server pools
  • Number of servers
  • Number of drives
  • Space on each drive
  • Space used on each drive
  • Number of buckets
  • Number of objects

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

Syntax

Parameters

ALIAS

Required

The alias of the AIStor deployment.

--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.

--api-key

API of the account on SUBNET.

Corresponds with the MC_SUBNET_API_KEY environment variable.

To find the API key:

  1. Log in to AIStor SUBNET
  2. Go to the Deployments tab
  3. Select the API Key button near the top of the page on the right side of the account statistics information box
  4. Select copy button to the right of the key field to copy the key value to your clipboard

--license

Optional

Path to the license file to use for registering the deployment.

You must first download the license file for the account.

--name

Optional

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

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

Examples

Register a Deployment Using the Deployment’s Name

Register the AIStor 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 Using the Account’s License File

Register a new AIStor deployment at alias minio5 on SUBNET, using the license file downloaded for the account:

mc license register minio5 /path/to/minio.license

If not already downloaded, you can download the license file from SUBNET.

Register a Deployment with a Different Deployment Name

Register an AIStor 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 an AIStor 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 link with token

  2. Open the copied registration link in a web browser and sign in to SUBNET

  3. Select the ? button to the right of the License number for the deployment

  4. In the popup, select the download link and save the key to a path you have access to

  5. In the command line, run the following command

    mc license update minio3 <path-to-file>
    

    Replace <path-to-file> with the path to the file you downloaded from SUBNET.

Global Flags

This command supports any of the global flags.