MinIO Admin Client

Table of Contents

Command Quick reference
Installation
Quickstart
Global Options

The MinIO Client mc command line tool provides The command 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 console`	The `mc admin console` command returns server log entries for each MinIO server in the deployment.
`mc admin decommission`	The `mc admin decommission` command starts the decommissioning process for a MinIO server pools . Decommissioning is designed for removing an older server pool whose hardware is no longer sufficient or performant compared to the pools in the deployment. MinIO automatically migrates data from the decommissioned pool to the remaining pools in the deployment based on the ratio of free space available in each pool.
`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 idp ldap`	The `mc admin idp ldap` commands allow you to add, modify, review, list, remove, enable, and disable server configurations to 3rd party Active Directory or LDAP Identity and Access Management (IAM) integrations .
`mc admin idp openid`	The `mc admin idp openid` commands allow you to add, modify, review, list, remove, enable, and disable server configurations to 3rd party OpenID Identity and Access Management (IAM) integrations .
`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 logs`	Use the `mc admin logs` command to show MinIO server logs.
`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 rebalance`	The `mc admin rebalance` command allows starts, monitors, or stops a rebalancing operation on a MinIO deployment. Rebalancing redistributes objects across all pools in the deployment.
`mc admin replicate`	The `mc admin replicate` command creates and manages site replication for a set of MinIO peer sites. Site replication mimics an active-active bucket replication, but for multiple MinIO deployments. Wherever a change occurs to IAM settings, buckets, or objects across the set of sites, the change replicates across all sites in the site replication group.
`mc admin service`	The `mc admin service` command can restart or stop MinIO servers.
`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 API operations occurring on the target MinIO 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 constitute a key component in MinIO Identity and Access Management.
`mc admin user svcacct`	The `mc admin user svcacct` command creates and manages Access Keys on a MinIO deployment.

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

          

ARM64

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

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

mc --help

          

macOS

           brew install minio/stable/mc
mc --help

Windows

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

          

Source

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 install github.com/minio/mc@latest

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 .