mc support register

Table of Contents

Description

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

After registration, upload deployment health reports directly to SUBNET using mc support diagnostics command.

Examples

Register a Deployment Using the Cluster’s Name

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

mc support register minio1

Register a Deployment with a Different Cluster Name

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

mc support register minio2 --name second-cluster

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 support 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] support 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 cluster in SUBNET.

Use --name <value> replacing <value> with the name you want to use for the cluster 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.

Global Flags

--debug
Optional

Enables verbose output to the console.

For example:

mc --debug COMMAND
--config-dir
Optional

The path to a JSON formatted configuration file that mc uses for storing data. See Configuration File for more information on how mc uses the configuration file.

--JSON
Optional

Enables JSON lines formatted output to the console.

For example:

mc --JSON COMMAND
--no-color
Optional

Disables the built-in color theme for console output. Useful for dumb terminals.

--quiet
Optional

Suppresses console output.

--insecure
Optional

Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.

--version
Optional

Displays the current version of mc.

--help
Optional

Displays a summary of command usage on the terminal.