Welcome to the upcoming version of the MinIO Documentation! The content on this page is under active development and may change at any time. If you can't find what you're looking for, check our legacy documentation. Thank you for your patience.

MinIO Admin (mc admin)

The MinIO Client mc command line tool provides the mc admin command for performing administrative tasks on your MinIO deployments.

While mc supports any S3-compatible service, mc admin only supports MinIO deployments.

mc admin has the following syntax:

mc admin [FLAGS] COMMAND [ARGUMENTS]

Command Quick reference

The following table lists mc admin commands:

Command

Description

mc admin bucket remote

The mc admin bucket remote command manages the ARN resources for use with bucket replication.

mc admin bucket quota

The mc admin bucket quota command manages per-bucket storage quotas.

mc admin group

The mc admin group command manages groups on a MinIO deployment.

mc admin heal

The mc admin heal command scans for objects that are damaged or corrupted and heals those objects.

mc admin info

The mc admin info command displays information on a MinIO server. For distributed MinIO deployments, mc admin info displays information for each MinIO server in the deployment.

mc admin kms key

The mc admin kms key command performs cryptographic key management operations through the MinIO Key Encryption Service (KES).

mc admin obd

The mc admin obd command generates detailed diagnostics for the target MinIO deployment as a GZIP compressed JSON file. MinIO Support may request the output of mc admin obd as part of troubleshooting and diagnostics.

mc admin policy

The mc admin policy command manages policies for use with MinIO Policy-Based Access Control (PBAC). MinIO PBAC uses IAM-compatible policy JSON documents to define rules for accessing resources on a MinIO server.

mc admin profile

The mc admin profile command generates profiling data for debugging purposes.

mc admin prometheus

The mc admin prometheus command generates a configuration file for use with Prometheus.

mc admin service

The mc admin service command can restart or stop MinIO servers.

mc admin speedtest

The mc admin speedtest command tests throughputs per host with PUT and GET operations.

mc admin tier

The mc admin tier command configures a remote supported S3-compatible service for supporting MinIO Lifecycle Management: Object Transition (“Tiering”).

mc admin top

The mc admin top command returns statistics for distributed MinIO deployments, similar to the output of the top command.

mc admin top is not supported on standalone MinIO deployments or MinIO Gateway deployments.

mc admin trace

The mc admin trace command displays the results of an HTTP TRACE request against each MinIO server in a deployment.

mc admin update

The mc admin update command updates all MinIO servers in the deployment. The command also supports using a private mirror server for environments where the deployment does not have public internet access.

mc admin user

The mc admin user command manages users on a MinIO deployment. Clients must authenticate to the MinIO deployment with the access key and secret key associated to a user on the deployment. MinIO users constitue a key component in MinIO Identity and Access Management.

Installation

Stable

docker pull minio/mc
docker run minio/mc admin info play

Edge

Do not use bleeding-edge deployments of MinIO in production environments

docker pull minio/mc:edge
docker run minio/mc:edge admin info server play

The following commands add a temporary extension to your system PATH for running the mc utility. Defer to your operating system instructions for making permanent modifications to your system PATH.

Alternatively, execute mc by navigating to the parent folder and running ./mc --help

64-bit Intel

curl https://dl.min.io/client/mc/release/linux-amd64/mc \
  --create-dirs \
  -o $HOME/minio-binaries/mc

chmod +x $HOME/minio-binaries/mc
export PATH=$PATH:$HOME/minio-binaries/

mc --help

64-bit PPC

curl https://dl.min.io/client/mc/release/linux-ppc64le/mc \
  --create-dirs \
  -o ~/minio-binaries/mc

chmod +x $HOME/minio-binaries/mc
export PATH=$PATH:$HOME/minio-binaries/

mc --help
brew install minio/stable/mc
mc --help

Open the following file in a browser:

https://dl.min.io/client/mc/release/windows-amd64/mc.exe

Execute the file by double clicking on it, or by running the following in the command prompt or powershell:

\path\to\mc.exe --help

Installation from source is intended for developers and advanced users and requires a working Golang environment. See How to install Golang.

Run the following commands in a terminal environment to install mc from source:

go get -d github.com/minio/mc
cd ${GOPATH}/src/github.com/minio/mc
make

To update a source-based installation, use go get -u. mc update does not support source-based installations.

Quickstart

Ensure that the host machine has mc installed prior to starting this procedure.

Important

The following example temporarily disables the bash history to mitigate the risk of authentication credentials leaking in plain text. This is a basic security measure and does not mitigate all possible attack vectors. Defer to security best practices for your operating system for inputting sensitive information on the command line.

Use the mc alias set command to add the deployment to the mc configuration.

bash +o history
mc config host add <ALIAS> <ENDPOINT> ACCESS_KEY SECRET_KEY
bash -o history

Replace each argument with the required values. Specifying only the mc config host add command starts an input prompt for entering the required values.

Use the mc admin info command to test the connection to the newly added MinIO deployment:

mc admin info <ALIAS>

Global Options

mc admin supports the same global options as mc. See Global Options.